Get schedule info

Get /external/schedule/{externalId}

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

Parameter	Type	Description
ExternalId	String	Schedule external id
Title	String	Schedule title
StartDateTime	DateTime	Date and time of assessment’s start
EndDateTime	DateTime	Date and time of assessment’s end
Hierarchy		Schedule hierarchy info
Hierarchy.ExternalId	String	Hierarchy external id
Hierarchy.FullPath	String	Hierarchy full path up to root hierarchy
ArchiveState	Integer	Possible values: 1 - Active 2 - Archived
IsActivated	Boolean	True if schedule is activated
Candidates		Schedule candidates info
Candidates.ExternalId	String	Candidate external id
Candidates.FirstName	string	Candidate first name
Candidates.LastName	String	Candidate last name
Candidates.UserName	String	Candidate user name
Invigilators		Schedule invigilators info
Invigilators.FirstName	String	Invigilator first name
Invigilators.LastName	String	Invigilator last name
Invigilators.UserName	String	Invigilator user name
SharingInformation	Array	Information about users who has access to this schedule
SharingInformation[].ExternalId	String	Invigilator externalId
SharingInformation[].FirstName	String	Invigilator first name
SharingInformation[].LastName	String	Invigilator last name
SharingInformation[].UserName	String	Invigilator user name
SharingInformation[].Email	String	Invigilator email

Sample Request URL

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

Sample successfull Response

{
    "Content": {
        "ExternalId": "EXT_sch_1",
        "Title": "new_title",
        "StartDateTime": "2018-05-21T10:00:00Z",
        "EndDateTime": "2018-05-25T20:00:00Z",
        "Hierarchy": {
            "ExternalId": null,
            "FullPath": "Test education"
        },
        "ArchiveState": 1,
        "IsActivated": false,
        "Candidates": [
            {
                "ExternalId": "EXT1",
                "FirstName": "Test",
                "LastName": "1",
                "UserName": "test1"
            },
            {
                "ExternalId": "EXT2",
                "FirstName": "Test",
                "LastName": "2",
                "UserName": "test2"
            }
        ],
        "Invigilators": [
            {
                "FirstName": "Invigilator",
                "LastName": "1",
                "UserName": "invigilator"
            }
        ]
    },
    "Success": true,
    "Errors": null
}

Responses

Code	Description
200	Successful operation
403	Not allowed to use external API
400	Schedule hasn't been found by external id
500	Internal server error