PUT /external/schedule/{externalId}/marking/void
Request Parameters
Parameters indicated with a * are mandatory
| Parameter | Type | Description |
|---|---|---|
| externalId* | String | schedule external id. |
Request Parameters (for message body)
Parameters indicated with a * are mandatory
| Parameter | Type | Description |
|---|---|---|
| Type* | String | Possible values: -"BY_ATTEMPT" -"BY_CANDIDATE" |
| AttemptExternalIds | Array [string] | Attempt external ids Mandatory: Yes (for Type = "BY_ATTEMPT") |
| CandidateExternalIds | Array [string] | Candidate external Mandatory: Yes (for Type = "BY_CANDIDATE") |
Sample Request
{
"Type": "BY_CANDIDATE",
"CandidateExternalIds": [‘7131’,’7140’,’7134’,’7132’]
}
Sample successfull Response
{
"Content": {
"SuccessfullyVoided": [‘7131’,’7140’],
"Errors": [
{
"CandidateExtId": "7134",
"Code": 400,
"Error": "Attempt is not found"
},
{
"CandidateExtId": "7132",
"Code": 1121,
"Error": "Attempt is already voided"
}
]
},
"Success": true,
"Errors": null
}
Response Parameters
(Parameters in Content field, see Basic response model:)
| Name | Type | Description |
|---|---|---|
| SuccessfullyVoided | Array [string] | External ids of successfully voided candidates or attempts |
| Errors | Array of objects | |
| Errors[].CandidateExtId | String | Candidate external Id with error |
| Errors[].AttemptExtId | String | Attempt external Id with error |
| Errors[].Error | String | This text shows what is wrong with either user or attempt Possible errors: CandidateExternalId can not be null or empty AttemptExternalId can not be null or empty User has not been found Attempt is not found Attempt is already voided Attempt is already published |
Responses
| Code | Description |
|---|---|
| 200 | Successful operation |
| 400 | Possible error codes: ScheduleExternalId can not be null or empty Request body can not be null or empty. Type cannot be null or empty CandidateExternalIds can not be null or empty AttemptExternalIds can not be null or empty Schedule has not been found Schedule is not activated |
| 403 | Not allowed to use external API |
| 500 | Internal server error |