Cancellation Reasons

Media type: application/json

Type: json

Content:

{ "$schema": "", "description": "Collection of cancellation reasons", "type": "object", "properties": { "cancellationReasons": { "description": "List of items", "id": "cancellationReasons", "type": "array", "items": { "type": "object", "$schema": "", "description": "Request cancellation reason", "properties": { "id": { "type": "string" }, "name": { "description": "Reason name", "type": "string" }, "description": { "description": "Internal reason description", "type": "string" }, "publicDescription": { "description": "Public reason description", "type": "string" }, "requiresAdditionalInformation": { "description": "Flag that indicates whether reason requires additional information", "type": "boolean" }, "source": { "description": "Origin of the cancellation reason record, e.g. 'System', 'User', 'Consortium' etc.", "type": "string" }, "metadata": { "readonly": true, "$schema": "", "id": "metadata.schema", "title": "Metadata Schema", "description": "Metadata about creation and changes to records, provided by the server (client should not provide)", "type": "object", "properties": { "createdDate": { "description": "Date and time when the record was created", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "ID of the user who created the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "createdByUsername": { "description": "Username of the user who created the record (when available)", "type": "string" }, "updatedDate": { "description": "Date and time when the record was last updated", "type": "string", "format": "date-time" }, "updatedByUserId": { "description": "ID of the user who last updated the record (when available)", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" }, "updatedByUsername": { "description": "Username of the user who last updated the record (when available)", "type": "string" } }, "additionalProperties": false, "required": [ "createdDate" ] } }, "additionalProperties": false, "required": [ "name" ] } }, "totalRecords": { "type": "integer" } }, "additionalProperties": false, "required": [ "cancellationReasons", "totalRecords" ]
}

Example:

{ "cancellationReasons": [ { "id": "5aace7aa-a741-4d69-9741-46737da78f7f", "name": "Not available", "description": "The item is no longer available", "publicDescription": "The item status is unknown", "requiresAdditionalInformation": false, "source": "System" } ], "totalRecords": 1
}

Bad request, e.g. malformed request body or query parameter. Details of the error (e.g. name of the parameter or line/character number with malformed data) provided in the response.

Media type: text/plain

Type: any

Example:

unable to list cancellation-reasons -- malformed parameter 'query', syntax error at column 6

Media type: text/plain

Type: any

Example:

unable to list cancellation-reasons -- unauthorized

Media type: application/json

Type: json

Content:

{ "$schema": "", "id": "errors.schema", "description": "A set of errors", "type": "object", "properties": { "errors": { "description": "List of errors", "id": "errors", "type": "array", "items": { "type": "object", "$schema": "", "id": "error.schema", "description": "An error", "properties": { "message": { "type": "string", "description": "Error message text" }, "type": { "type": "string", "description": "Error message type" }, "code": { "type": "string", "description": "Error message code" }, "parameters": { "description": "Error message parameters", "$schema": "", "id": "parameters.schema", "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } } }, "required": [ "message" ] } }, "total_records": { "description": "Total number of errors", "type": "integer" } }
}

Example:

{ "errors": [ { "message": "may not be null", "type": "1", "code": "-1", "parameters": [ { "key": "moduleTo", "value": "null" } ] } ]
}

Internal server error, e.g. due to misconfiguration

Media type: text/plain

Type: any

Example:

internal server error, contact administrator