Void attempts (during/after marking)
  • 29 Dec 2021
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Void attempts (during/after marking)

  • Dark
    Light
  • PDF

Article summary

PUT /external/schedule/{externalId}/marking/void

Request Parameters

Parameters indicated with a * are mandatory

ParameterTypeDescription
externalId*Stringschedule external id.

Request Parameters (for message body)

Parameters indicated with a * are mandatory

ParameterTypeDescription
Type*StringPossible values:
-"BY_ATTEMPT"
-"BY_CANDIDATE"
AttemptExternalIdsArray [string]Attempt external ids
Mandatory:
Yes (for Type = "BY_ATTEMPT")
CandidateExternalIdsArray [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:)

NameTypeDescription
SuccessfullyVoidedArray [string]External ids of successfully voided candidates or attempts
ErrorsArray of objects
Errors[].CandidateExtIdStringCandidate external Id with error
Errors[].AttemptExtIdStringAttempt external Id with error
Errors[].ErrorStringThis 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

CodeDescription
200Successful operation
400Possible 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
403Not allowed to use external API
500Internal server error


Was this article helpful?