Delete Enrollments
DELETE/api/web/v2/enrollments
Delete one or more enrollments. Caller requires the ENROLLMENTS:DELETE permission.
Request
- application/json
Body
required
List of Enrollment Ids to be deleted (Id should be in Base64 string format)
Responses
- 200
- 400
- 401
- 404
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
Error message for the failed enrollment record (For create/update/delete enrollments request)
fields
object[]
List of enrollment fields having field name and field value (For search enrollments request only)
Name of the enrollment field
Value of the enrollment field.
Accepted Date Formats: YYYY-MM-DD, MM/DD/YYYY, YYYY-MM-DDTHH:MM:SSZ, YYYY-MM-DDTHH:MM:SS
Id of the enrollment (In Base64 string format)
Status (Success/Failure) of the enrollment record (To check if the requested enrollment is successfully created/updated/deleted or not)
[
{
"error": "The record does not exist",
"fields": [
{
"name": "Bar Code",
"value": "12345678"
}
],
"id": "eyJ3b3JrZmxvd0lkIjoiNjE2ZTZiZmItNzI2NC00NjQ0LWE0MWMtMTFhZjE4MWRkZGFkIiwid2hlcmVDbGF1c2UiOnsiUVVJQ0tTVEFSVFBSSU1BUllLRVkiOiIxIn11",
"status": "Success"
}
]
Bad request
- application/json
- Schema
- Example (from schema)
Schema
The server error code
A human-readable representation of the error
The target of the error
{
"code": "string",
"message": "string",
"target": "string"
}
Authorization information is missing or invalid
- application/json
- Schema
- Example (from schema)
Schema
The server error code
A human-readable representation of the error
The target of the error
{
"code": "string",
"message": "string",
"target": "string"
}
The specified resource was not found
- application/json
- Schema
- Example (from schema)
Schema
The server error code
A human-readable representation of the error
The target of the error
{
"code": "string",
"message": "string",
"target": "string"
}
Unexpected error
- application/json
- Schema
- Example (from schema)
Schema
The server error code
A human-readable representation of the error
The target of the error
{
"code": "string",
"message": "string",
"target": "string"
}