List MarkersInboxItems

GET

/markers-inbox-items

Request

Query Params

string

optional

marked

boolean

optional

enum<string>

optional

Allowed values:

questionattempt

questionType

array[string]

optional

Filter by question type. This filter will only be applied when filtering by by=question

Allowed values:

audioRecordingvideoRecordingfreeTextfileUpload

markingStatus

array[string]

optional

Filter by attempt marking status. This filter will only be applied when also filtering by by=attempt

Allowed values:

notStartedinProgressreadyToFinalisefinalisedcompleted

exam

array[string]

optional

sort

enum<string>

optional

Allowed values:

submittedAt-submittedAtquestionResponseCount-questionResponseCountexamName-examNamequestionCredits-questionCredits

limit

number

required

>= 1

offset

number

required

>= 0

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

array[object (MarkersInboxItem) {4}]

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

MarkersInboxItem

Example:

MarkersInboxItem

attributes

object

optional

relationships

object

optional

included

array[object (GenericResource) {4}]

optional

string

optional

The primary key for each resource.

Example:

FID001

type

string

optional

Identifies the Resource.

Example:

_User

attributes

object

optional

relationships

object

optional

meta

object

optional

total

integer

required

totalWithoutFilters

integer

optional

pages

integer

required

page

integer

required

offset

integer

required

limit

integer

required

totalCount

integer

deprecated

resultCount

integer

deprecated

totalPages

integer

deprecated

currentPage

integer

deprecated

unmarkedCount

integer

optional

unmarkedMeanWaitDays

number

optional

unmarkedMaxWaitDays

integer

optional

markedCount

integer

optional

markedWeeklyRollingCount

integer

optional

unmarkedResponseCount

integer

optional

markedResponseCount

integer

optional

Example

{
    "data": [
        {
            "id": "FID001",
            "type": "MarkersInboxItem",
            "attributes": {
                "submittedAt": "string",
                "submissionStatus": "onTime",
                "markingStatus": "notStarted",
                "markingSessions": [
                    {
                        "sessionId": "string",
                        "markerRole": "provisional"
                    }
                ]
            },
            "relationships": {
                "attempt": {
                    "data": {
                        "id": "FID001",
                        "type": "Attempt"
                    }
                },
                "examV2": {
                    "data": {
                        "id": "FID001",
                        "type": "Exam-V-2"
                    }
                },
                "candidate": {
                    "data": {
                        "id": "FID001",
                        "type": "User"
                    }
                },
                "question": {
                    "data": {
                        "id": "FID001",
                        "type": "QuizQuestion"
                    }
                }
            }
        }
    ],
    "included": [
        {
            "id": "FID001",
            "type": "_User",
            "attributes": {},
            "relationships": {
                "property1": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                },
                "property2": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                }
            }
        }
    ],
    "meta": {
        "total": 0,
        "totalWithoutFilters": 0,
        "pages": 0,
        "page": 0,
        "offset": 0,
        "limit": 0,
        "totalCount": 0,
        "resultCount": 0,
        "totalPages": 0,
        "currentPage": 0,
        "unmarkedCount": 0,
        "unmarkedMeanWaitDays": 0,
        "unmarkedMaxWaitDays": 0,
        "markedCount": 0,
        "markedWeeklyRollingCount": 0,
        "unmarkedResponseCount": 0,
        "markedResponseCount": 0
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Modified at 2025-07-08 10:51:21

Create ExamineeNotification

Get Chart