Error management

In an HTTP protocol, the response statuses are identified by HTTP response status codes. All HTTP response status codes are separated into five categories.

The first digit of the status code defines the category of response. The last two digits are used to identify the status of API call more specifically. There are five values for the first digit:

• 1xx (Informational): The request was received, continuing process.
• 2xx (Successful): The request was successfully received, understood and accepted.
• 3xx (Redirection): Further action needs to be taken in order to complete the request.
• 4xx (Client Error): The request contains bad syntax or cannot be fulfilled.
• 5xx (Server Error): The server failed to fulfill an apparently valid request.

This list shows how API Gateway Connection point handles response codes:

• 2xx status codes are considered as a success. When such status code is received, the data flow continues.
• Status codes 401, 500, 503, 504 are considered as a connection error. When such status code is received, the connection point retries sending the request again.
• All other status codes are considered as a document-specific configuration error. When such status code is received the connection point generates a Confirm BOD.