Error handling

CTMS Errors

The CTMS API is a REST API and returns the usual HTTP error codes.

Calls to the CTMS API often return a standard CTMS error response with HTTP header
Content-Type: application/vnd.avid.problem+json
and a JSON description of the error in the response body.

Example

{
  "code": "avid.pam/CTMS/INVALID_PARAMETER",
  "message": "Not a valid mob id (UMID): abcd",
  "params": {
    "message": "Not a valid mob id (UMID): abcd",
    "parameterName": "mobID"
  },
  "status": 400
}

Properties

Property	Description
code	Error code. It can be used programmatically to react to specific error conditions. The code consists of a list of elements separated by a slash. The last element is the actual error code. The second-to-last element can be "CTMS" to indicate common CTMS errors. The first element can be the name of the service that returns the error. Example: avid.pam/CTMS/INVALID_PARAMETER
message	English error message. It can be displayed to the user or written to log files.
params	Optional list of parameters for the error.
status	Optional. The HTTP status code of the error.

Property

Description

code

Error code.

It can be used programmatically to react to specific error conditions.

The code consists of a list of elements separated by a slash. The last element is the actual error code. The second-to-last element can be "CTMS" to indicate common CTMS errors. The first element can be the name of the service that returns the error.

Example: avid.pam/CTMS/INVALID_PARAMETER

message

English error message.

It can be displayed to the user or written to log files.

params

Optional list of parameters for the error.

status

Optional. The HTTP status code of the error.

See Common Error Codes for details and a list of common CTMS error codes.

Previous page: Querying the CTMS Registry

Up: Quick start

Next page: Handling assets