Exception handling
In case of error, besides returning the standard HTTP Server error code (500).
The MFT FS REST Services API endpoints returns more detailed information about the error in a structured format as part of response body.
Error response
Error data transfer object
| Item Name | Data Type | Sample Value | Comments |
|---|---|---|---|
| Message | String | “Invalid File ID: 12345” | Describes the type of error, indicating (when possible) which input value(s) could have caused the error |
| ErrorCode | Integer | 7001 | A numeric code that identifies the type of error |
Sample response (in XML)
<ErrorInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Message>Session no longer exists.</Message>
<ErrorCode>101</ErrorCode>
</ErrorInfo>
Error codes
Each type of error generated by the MFT FS REST Services API has its own numeric code.
Which is returned in the ErrorCode field of the ErrorInfo object.
The codes can be used to determine client course of action.
For the actual error codes, refer to the Understanding REST API error codes topic.
Was this topic helpful?
