Invigilation Info

Get invigilator dashboard info

GET /schedule/{scheduleExternalId}/invigilation-info

It allows you to retrieve all invigilator dashboard info, such as an attendance sheet

Header

Name	Data Type	Description
Content-type:	application/json	for all requests
Authorization:	EAPI {token}	for all requests

Request Parameters

Parameters indicated with a * are mandatory

Parameter	Type	Description
externalId	String(60)	Schedule external id

Response Parameters

Parameters indicated with a * are mandatory

Parameter	Type	Description
ScheduleTitle	String	Title of schedule
CandidateName	Type	Full name of candidate
CandidateExtId	String	User id candidate
PinCode	String	Pin code, if it was used, if not set returns null
Status	String	Status of candidate, following options are possilbe 'NOT_STARTED'; 'HANDED_IN';'VOID';'IN_PROGRESS'
Attempt	Integer	Attempt number
StartTime	DateTime	Start DateTime string representation according to RFC 3339 2021-04-21T07:30:00.000Z (UTC)
EndTime	DateTime	End DateTime string representation according to RFC 3339 2021-04-21T07:30:00.000Z (UTC)
ExamDuration	Integer	duration of schedule in minutes. If no duration is set returns: 0
ExtraTimeForCurrentAttempt	Integer	Extra time in minutes setup by special needs or/and during invigilation. If 'ExtraTime' = Unlimited it will return '9999'
ExtraTimeForNextAttempt	Integer	Extra time in minutes for next attempt
ExamSubmittedBy	String	Who handed in the exam, possible options: 'SYSTEM';'CANDIDATE'

Sample Request URL

https://api.cirrusplatform.com/api/v1/integrations/external/schedule/EXT_sch_1/invigilation-info

Sample successfull Response

{
    "Content": [
        {
            "ScheduleTitle": "Accountancy 101",
            "CandidateName": "John Doe",
            "CandidateExtId": "7132",
            "PinCode": "6961",
            "Status": "HANDED_IN",
            "Attempt": "2",
            "StartTime": "2022-06-21T14:09:32.426Z", 
            "EndTime": "2022-06-21T14:41:33.386Z", 
            "TimeSpent": "00:32:00",
            "ExamDuration": 2,
            "ExtraTimeForCurrentAttempt": 30,
            "ExtraTimeForNextAttempt": 30,
            "ExamSubmittedBy": "SYSTEM"
        },
        {
            "ScheduleTitle": "Accountancy 101",
            "CandidateName": "Jane Doe",
            "CandidateExtId": "7133",
            "PinCode": "6961",
            "Status": "NOT_STARTED",
            "Attempt": "0",
            "StartTime": null,
            "EndTime": null,
            "TimeSpent": "00:00:00",
            "ExamDuration": 2,
            "ExtraTimeForCurrentAttempt": 0,
            "ExtraTimeForNextAttempt": 0,
            "ExamSubmittedBy": null
        },
        ...
    ],
    "Success": true,
    "Errors": null
}

Sample unsuccessfull Response

{
    "Success": false,
    "Errors": "Schedule is not activated",
    "ErrorDetails": [
        {
            "Code": 303,
            "Error": "Schedule is not activated"
        }
    ]
}

Responses

Code	Description
200	Successful operation
400	Possible errors: 301: Schedule has not been found 303: Schedule is not activated
403	Not allowed to use external API
500	Internal server error