Errors

Transatel APIs errors

Transatel REST APIs use HTTP standard status codes in response of all API request to indicate the result of an API call.

2xx codes indicate a success.
4xx codes indicate an error in the provided information (e.g a missing mandatory parameter).
5xx codes indicate an error in Transatel's servers.

Error format

Together with the HTTP status, a response is provided as a JSON object with the details of the error. The format of those error responses follows the RFC 7807 .

Below is the description of the different error response fields:

Field	Type	Description
type	String	A URI reference that identifies the problem. You can use this URI to reach the API reference documentation about the given error.
title	String	A string reference that identifies the problem.
status	Number	The HTTP status code for this occurrence of the problem.
detail	String	A human-readable explanation specific to this occurrence of the problem.
path	String	Path to the requested resource.

Example of error response:

{
  "type": "https://api.transatel.com/ocs/subscriptions/docs#errors/SUBSCRIBER_NOT_FOUND",
  "title": "SUBSCRIBER_NOT_FOUND",
  "status": 400,
  "detail": "Order failed - Subscriber is unknown",
  "path": "/ocs/subscriptions/api/orders/products"
}

Common errors

Below are common errors that can be raised directly by our API gateway:

Status	Title	Description
401	UNAUTHORIZED	Unauthorized, no valid authentication token provided. Please provide a valid token retrieved from our authentication API. See our authentication guide for more details.
404	NOT_FOUND	Not found, the provided URL does not map any of our API operation. Please check our API reference documentations to discover available operations.
405	METHOD_NOT_ALLOWED	Method not allowed, the provided method for this URL does not map any of our API operation. Please check our API reference documentations to discover available operations.
406	NOT_ACCEPTABLE	Not acceptable, the API operation at the provided URL does not provide the requested content type. Please check our API reference documentations to discover available operations.
415	UNSUPPORTED_MEDIA_TYPE	Unsupported media type, the payload format is not accepted, please check that you did provide a valid JSON payload.
429	TOO_MANY_REQUESTS	Too many requests, you have reached the configured limit of API requests. Please contact your account manager to know more about it.
500	INTERNAL_ERROR	Server error, please check maintenance schedule or try again later.
503	SERVICE_UNAVAILABLE	Service unavailable, the API is temporarily unavailable. Please try again later.
504	GATEWAY_TIMEOUT	Gateway timeout, the upstream service was unresponsive. Please try again later.

API specific errors

Apart from common errors described above, each API can return its own specific errors. To read more about those, please check the Errors section in appendix of each API reference documentation.