Contents x
    Update schedule
    • 17 Apr 2024
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Contents

    Update schedule

    • Updated on 17 Apr 2024
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Article Summary

    PATCH /external/schedule/{externalId}

    Before using this API method Scheduler id must be set in External API settings of Cirrus app.

    Note: Using the API it possible to update a schedule even if a scheduler has opened it in the platform. The last performed save action (by API or GUI) will be the final state. The user will not receive a message if the opened schedule has been updated by the API.

    Request Parameters

    Parameters indicated with a * are mandatory

    Name
    Data Type
    		Description
    externalId*StringSchedule external id
    NameData TypeDescription
    Content-type:application/jsonfor all requests
    Authorization:EAPI {token}for all requests

    Request Parameters (for message body)

    Parameters indicated with a * are mandatory

    Name
    Data Type
    		Description
    StartDateTime*DateTimeDateTime string representation according to RFC 3339
    2021-04-21T07:30:00.000Z (UTC)
    EndDateTimeDateTimeDateTime string representation according to RFC 3339

    2021-04-21T07:30:00.000Z (UTC)
    Titlestring (100)Schedule title
    ScheduleExtIdstring (64)Alphanumeric Dashes
    Schedule external id
    HierarchyExternalIdstring (500)Hierarchy external id (GroupId) for schedule
    PINstring (4)PIN for candidates, can only be changed for inactive schedules. In case you would like to update the pincode for an active schedule, please use the api call 'Update Pincode for active schedule'
    UseProctorIobooleanDefines if exam should be integrated with Proctorio
    If not provided, value from assessment options will be used
    ProctorioTemplateExternalIdString(64)Alphanumeric. Defines which proctorio template will be used for this exam
    If not provided. Default template will be used from global settings > Proctorio

    Sample Request URL

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

    Sample Request

    {
     "Title": "Test",
     "ScheduleExternalId": "EXT_sch_12",
     "StartDateTime": "2018-05-21T10:00:00",
     "EndDateTime": "2018-05-25T20:00:00",
     "PIN": "1234"
}

    Sample Response

    {
    "Content": "EXT_sch_12",
    "Success": true,
    "Errors": null    
}

    Response codes

    CodeDescription
    200Successful operation
    403Not allowed to use external API
    400Possible errors:
    Invalid input data (all fields in message body are empty)
    Schedule hasn't been found by external id
    Can’t update activated schedule
    Hierarchy hasn't been found by external id
    Scheduler hasn’t been set in External API settings
    Selected scheduler no longer has permission to create, update and delete schedules
    Hierarchy hasn’t been found by external id {ExternalId} or is archived
    500Internal server error
    Was this article helpful?
    What's Next