Contents x
    Get schedule info
    • 29 Oct 2021
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Contents

    Get schedule info

    • Updated on 29 Oct 2021
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Get schedule info

    Get /external/schedule/{externalId}
    NameData TypeDescription
    Content-type:application/jsonfor all requests
    Authorization:EAPI {token}for all requests

    Request Parameters

    Parameters indicated with a * are mandatory

    ParameterTypeDescription
    externalIdString(60)Schedule external id

    Response Parameters

    ParameterTypeDescription
    ExternalIdStringSchedule external id
    TitleStringSchedule title
    StartDateTimeDateTimeDate and time of assessment’s start
    EndDateTimeDateTimeDate and time of assessment’s end
    HierarchySchedule hierarchy info
    Hierarchy.ExternalIdStringHierarchy external id
    Hierarchy.FullPathStringHierarchy full path up to root hierarchy
    ArchiveStateIntegerPossible values:
    1 - Active
    2 - Archived
    IsActivatedBooleanTrue if schedule is activated
    CandidatesSchedule candidates info
    Candidates.ExternalIdStringCandidate external id
    Candidates.FirstNamestringCandidate first name
    Candidates.LastNameStringCandidate last name
    Candidates.UserNameStringCandidate user name
    InvigilatorsSchedule invigilators info
    Invigilators.FirstNameStringInvigilator first name
    Invigilators.LastNameStringInvigilator last name
    Invigilators.UserNameStringInvigilator user name
    SharingInformationArrayInformation about users who has access to this schedule
    SharingInformation[].ExternalIdStringInvigilator externalId
    SharingInformation[].FirstNameStringInvigilator first name
    SharingInformation[].LastNameStringInvigilator last name
    SharingInformation[].UserNameStringInvigilator user name
    SharingInformation[].EmailStringInvigilator 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

    CodeDescription
    200Successful operation
    403Not allowed to use external API
    400Schedule hasn't been found by external id
    500Internal server error
    Was this article helpful?
    What's Next