MENU
    Delete invigilators from schedule
    • 01 Jul 2021
    • 1 Minute to read
    • Contributors

    Delete invigilators from schedule


    Article summary

    Delete invigilators from schedule

    DELETE /schedule/{externalId}/invigilators

    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,userexternalidexample1"]
    JSON


    Sample successfull Response

    {
        "Content": {
            "SuccessfullyRemoved": [
                "13081986"
            ],
            "Errors": []
        },
        "Success": true,
        "Errors": null
    }
    JSON


    Sample unsuccessfull Response

    {
        "Content": {
            "SuccessfullyRemoved": [],
            "Errors": [
                {
                    "UserExtId": "89999",
                    "Code": 319,
                    "Error": "User has not been added as invigilator of this schedule"
                }
            ]
        },
        "Success": true,
        "Errors": null
    }
    JSON

    Responses

    CodeDescription
    200Successful operation
    200Possible errors:
    100: Request body can not be null or empty
    200: Request does not contains any valid user external ids
    300: ScheduleExternalId can not be null or empty
    301: Schedule has not been found
    302: Schedule is archived
    302: Schedule is archived
    305: Schedule is finished
    319: User has not been added as invigilator of this schedule
    403Not allowed to use external API
    500Internal server error


    Was this article helpful?