Contents x
    Void Attempt
    • 30 Jun 2021
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Contents

    Void Attempt

    • Updated on 30 Jun 2021
    • 1 Minute to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Article Summary

    PUT /api/v1/integrations/external/schedule/{externalId}/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
    Array [string]External ids of candidates*

    Sample Request

    [‘7131’,’7140’]

    Sample successfull Response

    {
    "Content": [
        SuccessfullyUpdated: ["EXT1","EXT2"],
        Errors: [ 
        {
            "CandidateExtId": "EXT3",
            "Error": "User NOT found",
        },
        {
            "CandidateExtId": "EXT4",
            "Error": "Attempt cannot be started",
        }],
    "Success": true,
    "Errors": null
}

    Responses

    CodeDescription
    200Successful operation
    400Possible error codes:
    Schedule has not been found
    Schedule is archived
    Schedule is not in progress
    Schedule is not activated
    403Not allowed to use external API
    500Internal server error
    Was this article helpful?
    What's Next