Delete Enrolment

Delete Enrolment

Path Parameters
enrolmentLocalId string — REQUIRED

Header Parameters
EID string — REQUIRED Enter the EDUMIS (Organisation) ID

Request Body The Enrolment to delete.
deletionReason string — REQUIRED Possible values: 1 ≤ length ≤ 2 Deletion Reason Code identifying the reason for the programme enrolment deletion. Length: 2 Type: Character Guidance: Select a value from the list below. ID: Programme enrolment contained an incorrect participation start date IE: Programme enrolment was invalid IS: Programme enrolment has incorrect status in DXP OT: Other This field is required when a ‘Deletion Date’ is provided.
deletionDate date — REQUIRED Deletion Date Date the programme enrolment was deleted. Type: Date Guidance: 2024-04-08 You must use ISO-8601 for your dates.

Responses
200 The enrolment was deleted successfully.
400 Bad request. Check errors and codes for more detail. Schema — OPTIONAL type string — OPTIONAL title string — OPTIONAL status int32 — OPTIONAL detail string — OPTIONAL instance string — OPTIONAL errors object — OPTIONAL
401 Unauthorized Schema — OPTIONAL type string — OPTIONAL title string — OPTIONAL status int32 — OPTIONAL detail string — OPTIONAL instance string — OPTIONAL errors object — OPTIONAL
429 Rate Limiting may apply. Refer to Retry-After header Schema — OPTIONAL type string — OPTIONAL title string — OPTIONAL status int32 — OPTIONAL detail string — OPTIONAL instance string — OPTIONAL