Add candidates to schedule
  • 30 Jun 2021
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Add candidates to schedule

  • Dark
    Light
  • PDF

Article summary

Add candidates to schedule

PUT /schedule/{externalId}/candidates

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

Request Parameters

Parameters indicated with a * are mandatory

ParameterTypeDescriptionmax length
externalId*StringThe external ID of the schedule

Request Parameters (for message body)

Parameters indicated with a * are mandatory

ParameterTypeDescriptionmax length
Array*StringExternal ids of invigilators

Sample Body Request

["userexternalidexample1,userexternalidexample2"]


Sample successfull Response

{
    "Content": {
        "AddedCandidateExternalIds": [],
        "NotFoundUserExternalIds": [],
        "AlreadyAddedCandidateExternalIds": [
            "cirrus_user_ext_id1"
        ]
    },
    "Success": true,
    "Errors": null
}


Responses

CodeDescription
200Successful operation
400Possible errors:
Schedule hasn't been found by external id
No external ids have been provided
No users were found by external ids
Scheduler hasn’t been set in External API settings
Selected scheduler no longer has permission to create, update and delete schedules
403Not allowed to use external API
500Internal server error


Was this article helpful?