Media Reports API Debugging

This section provides details on the format of error response objects, and provides details on the range of response codes.

Error Responses for Media Delivery Reports

The error JSON below is returned for all non–2xx HTTPS status codes. The returned HTTP response code corresponds to the httpStatus element in the JSON response. This enables the caller to not have to query the header for the response code.

    "httpStatus": 404,
    "detail": "additional non-http specific info where relevant",
    "title": "Resource not found"

Error Responses for Media Streaming Live Reports

The rest-utils-dtos implementation supports the following fields:

  • type : A URI that points to additional documentation.

  • title : A short, consistent, human-readable description of the error type.

  • instance : A unique ID that identifies the specific instance of the problem.

  • status : HTTP status code.

  • detail : A human-readable description of what went wrong.

    "type": "",
    "title": "Resource Not Found",
    "instance": "83b9feb7-7006-47c0-9263-cadaff262d84",
    "status": 404,
    "detail": "additional non-http specific info where relevant"

HTTP Status Codes

API calls can return any of the following response codes:

Code Description
200 OK.
204 No data. Media Services Live Reports returns a 200 response code with empty rows in the response body for /data requests.
400 Bad input parameter. Error message should indicate which one and why.
401 Authentication failure.
403 Authorization failure.
404 Resource not found.
405 Request method not expected (generally should be GET).
409 Conflict.
410 Requested resource is no longer available.
411 Content-length header not specified.
413 Request body exceeds maximum allowable size.
423 Requested resource is locked.
429 Too many requests.
500 Internal server error; unexpected condition.
501 Not supported.
503 Too many requests; service is temporarily unavailable.
507 Data size is over allowable limit.

Last modified: 1/25/2018