Error responses
Error responses contain the HTTP status code that is returned to the requester along with information about what caused the error.
Error messages that are returned from Rapid Transit follow a template and can consist of multiple "exceptions" depending on where in the process the exception occurred. The last exception is usually the only one with useful information for debugging.
Rapid Transit error response template
<RTPError>
<errorCode>{HTTP Status Code}</errorCode>
<errorMessage>{Status Message}</errorMessage>
<sourceMessageID>{Message ID}</sourceMessageID>
<brokerName>{Broker Node Name}</brokerName>
<messageFlowLabel>{Message Flow Name}</messageFlowLabel>
<datetimeStamp>{DateTime}</datetimeStamp>
<exceptions>
<exception>
<code>{Error code}</code>
<label>{Error Location}</label>
<text>{Error Summary}</text>
<inserts>{Error Message}</inserts>
</exception>
.
.
.
</exceptions>
</RTPError>Explanation of response elements
| Response element | Description |
|---|---|
{HTTP Status Code} |
This element is error-specific and corresponds to either a 400-level or 500-level error code |
{Status Message} |
The generic status message associated with the status code |
{Message ID} |
A randomly generated UUID that is used to idenfity the document internally |
{Broker Node Name} |
The name of the IIB instance on which the exception occurred |
{Message Flow Name} |
The name of the message flow on which the exception occurred |
{DateTime} |
The date and time at which the exception occurred |
{Error code} |
The internal error code that is associated with the exception |
{Error Location} |
The location in Rapid Transit where the exception occurred |
{Error Summary} |
The summary of the exception |
{Error Message} |
The description of the exception |