API Responses
Generic / Common response codes
Each resource can return it’s own specific status codes, below are the generic codes shared among all.
Code | Description |
---|---|
101 | Authentication failed, please check the token / secret used and that you have access to the requested service |
102 | Permission denied to this customer code / site code |
110 | Invalid parameters specified for the requested API |
150 | An error occurred in the requested service |
200 | OK - the request was handled successfully and will be passed for processing. |
401 | Unauthorised - the access token used has probably expired and needs to be refreshed using the refresh_token and the original request reattempted |
403 | API access restricted (Exceeded the rate limit / access not allowed) Forbidden - This is usually returned when a POST request is submitted but the user’s API account is not permitted in EDI to POST (only GET is permitted). POST submissions are restricted because they require testing and approval before being allowed. |
500 | Internal server error but could also be caused by an invalid request (invalid encoding, data types etc) |
GET Specific Responses
Code | Description |
---|---|
204 | No record found for the parameters provided |
429 | API access restricted |
POST Specific Responses
Code | Description |
---|---|
207 | Multi-Status, <RES> tag have more information |
400 | Request processing all record failed, <RES> tag have more information |
406 | Input XML validation failed, response body will have reason for failure |
Copyright Ontech Solutions 2017-2024. All rights reserved, no part may be replicated or distributed without the express permission of the owner.