Status Codes
The API must return the exceptionDetailType object
for API errors as shown in the following example:
{
"o:errorCode":55203,
"detail":"Missing required request parameters to access the resource",
"status":400,
"type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
"title":"VALIDATION ERROR",
"errorDetails": {[custom error object]}
}When you call an endpoint, the response header returns a standard HTTP status code. Most responses are in JSON format. Each endpoint topic in this document has Request and Response sections which list supported media types for the endpoint.
To request a specific response format, specify the format in the Accept HTTP header (see RFC7231). The API supplies only the format requested by the client in the "Accepts" HTTP header.
If the endpoint supports multiple response formats, and the API prefers
one format over another, this is specified using the q parameter (built into HTTP as "content type negotiation" as defined
in RFC7231).
| HTTP Status Code | Description |
|---|---|
|
|
The request was completed successfully. A 200
status is returned for a successful |
|
|
The request is fulfilled, but there is no content available in the system. |
|
|
The request could not be processed because it contains missing or invalid information (for example, a validation error on an input field or a missing required value). |
|
|
The request is not authorized. The authentication credentials included with the request are missing or invalid. |
|
|
The user cannot be authenticated. The user does not have authorization to perform the request. |
|
|
The request includes a resource URL which does not exist. |
|
|
The HTTP verb specified in the request ( |
|
|
The resource identified by this request cannot generate a representation corresponding to one of the media types in the Accept header of the request. For example, the client's Accept header request XML can be returned, but the resource can only return JSON. |
|
|
The request could not be completed because of a conflict with the current state of the resource. Either the version number does not match or a duplicate resource was requested. |
|
|
The client's Content Type header is not correct (for example, the client attempts to send the request in XML, but the resource can only accept JSON). |
|
|
The request could not be processed because too many requests were sent to the server. |
|
|
The server encountered an unexpected condition which prevented it from fulfilling the request. |
|
|
The server is unable to handle the request due to the temporary overloading or maintenance of the server. The REST web application is not currently running. |
| o:errorCode | API |
|---|---|
|
551XX |
Authentication and Authorization Errors |
|
552XX |
Validation Errors |
|
553XX |
System Errors |
Authentication or Authorization
| o:errorCode | Server Code (title) | HTTP Status (status) | Message (detail) | Type | Context | errorDetails |
|---|---|---|---|---|---|---|
|
55101 |
INVALID CLIENT ID |
401 |
The client ID is not valid. |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2 |
The Client ID provided for authorization is invalid. |
API Account is not found. |
|
55102 |
FORBIDDEN |
403 |
The organization identifier in your request does not match the identity you provided. |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4 |
The Organization identifier in the request URL does not match the API account's organization. The user does not have access to the resource due to the following reasons:
|
|
|
55103 |
INVALID ACCOUNT |
401 |
Your request is missing the account user name, password, or organization. Or, one or more of those values is incorrect in your request. |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2 |
When the user provides an incorrect API account username password or organization during authorization. |
Ensure the username and password included in the request are correct. |
|
55104 |
INVALID AUTH CODE |
401 |
The authCode value is missing or the value you provided is incorrect. |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2 |
The authorization code to get the token is missing or incorrect. |
|
|
55105 |
MISSING AUTH TOKEN |
401 |
The OAuth token is missing. |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2 |
The authentication token is not provided in the request. |
|
|
55106 |
INVALID AUTH TOKEN |
401 |
The OAuth token is not valid or has expired. |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2 |
The authentication token is invalid due to the following
reasons:
|
|
|
55107 |
FORBIDDEN |
403 |
You do not have the permissions to access this resource |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2 |
The user does not have sufficient permissions to access the resource. |
|
|
55108 |
RESOURCE NOT FOUND |
404 |
There is not a resource at the end point you provided. Ensure you specified the correct path. |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5 |
The user provides an invalid path to access the API. |
|
|
55109 |
Invalid AuthIdentityId |
404 |
The AuthIdentityId is invalid because it does not exist or it is not configured. |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5 |
The AuthIdentityId is invalid because it does not exist or it is not configured |
The AuthIdentityId is invalid because it does not exist or it is not configured |
|
55110 |
Invalid Credential type |
404 |
The Credentialtype provided is not valid. |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5 |
The Credential type provided is invalid |
The Credential type provided is invalid |
|
55111 |
Invalid Auth Request |
404 |
The Request is missing the AuthIdentityType, AuthIdentityId, CredentialType, and userIdenitifer, or one or more of those values is incorrect in your request. |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5 |
AuthIdentityType, AuthIdentityId, CredentialType, userIdentifier are either missing or incorrect. |
The Request is missing the AuthIdentityType, AuthIdentityId, CredentialType, and userIdenitifer, or one or more of those values is incorrect in your request. |
Validation
| o:errorCode | Server Code (title) | HTTP Status (status) | Message (detail) | Type | Context | errorDetails |
|---|---|---|---|---|---|---|
|
55201 |
VALIDATION ERROR |
400 |
Field is too long |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 |
When the request parameter field is longer than the specified length. |
<fieldname> cannot be greater than <fieldlength> characters |
|
55202 |
VALIDATION ERROR |
400 |
Field is too small |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 |
When the request parameter field is shorter than the specified length. |
<fieldname> cannot be less than <fieldlength> characters |
|
55203 |
VALIDATION ERROR |
400 |
Object number cannot be edited |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 |
<Object Number> cannot be edited |
|
|
55204 |
VALIDATION ERROR |
400 |
Missing required request parameters to access the resource |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 |
When the user does not provide the mandatory request parameters for accessing the API. |
Contains the custom object with the missing parameter names |
|
55205 |
VALIDATION ERROR |
400 |
Syntax is invalid for one or more fields |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 |
When the user provides invalid syntax for the request parameters. |
Contains the custom object with parameter names with invalid syntax |
|
55206 |
VALIDATION ERROR |
400 |
Incorrect data type for one or more fields |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 |
When the user provides an incorrect data type for the request parameters. |
Contains the custom object with parameter names with the incorrect data types |
|
55207 |
METHOD NOT ALLOWED |
405 |
HTTP method not allowed |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6 |
When the user provides the HTTP method which is not supported by the API. |
|
|
55208 |
VALIDATION ERROR |
400 |
Syntax Error |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 |
For use with searchCriteria() when a parenthesis is missing. |
<type of syntax error> at position <x> in <request parameter name>:
|
|
55209 |
VALIDATION ERROR |
400 |
Resource not supported at the hierarchy unit |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4 |
When the request does not exist at this level. |
Resource <> does not exist at this hierarchy |
|
55210 |
VALIDATION ERROR |
400 |
Maximum objects exceeded |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 |
When the request parameter field is higher than expected. |
Only <x> number of records can be defined for the <resource name> |
|
55211 |
VALIDATION ERROR |
400 |
Missing required body parameters |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 |
Missing required body parameters |
<attribute name> / <names> cannot be null in the request body |
|
55212 |
VALIDATION ERROR |
400 |
Incorrect data type |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 |
Incorrect data type |
<data type> expected for <field name> Note: One row per data type mismatch |
|
55213 |
VALIDATION ERROR |
400 |
Unsupported object |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 |
Unsupported object |
<Object> does not support under this <Org type> |
|
55214 |
VALIDATION ERROR |
400 |
Field reference not found |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 |
Field reference not found |
<Value> not found for <attribute name> Note: One row for each mismatch |
|
55215 |
VALIDATION ERROR |
400 |
Invalid LanguageID value |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 |
Invalid LanguageID value |
Invalid Language Id specified |
|
55216 |
VALIDATION ERROR |
400 |
Resource cannot be deleted |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 |
Resource cannot be deleted |
<Value> referred in <Resource Name> Note: One row for each reference |
|
55217 |
VALIDATION ERROR |
400 |
Invalid body parameters |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 |
When a user provides invalid parameters in the request body |
Invalid body parameters value |
|
55218 |
VALIDATION ERROR |
400 |
Invalid request |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 |
The request for the resource is invalid due to a specific reason |
Offset provided is greater than the total number of results for the resource. Verify and retry. |
|
55219 |
VALIDATION ERROR |
400 |
Invalid range |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 |
When a user provides invalid range parameters in the request body |
Invalid range specified |
|
55220 |
VALIDATION ERROR |
400 |
Object number already exists |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 |
When user tries to insert an object number which already exists |
Object Number already exists |
|
55221 |
VALIDATION ERROR |
400 |
Object number does not exist |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 |
When user provides invalid range parameters in the request body |
Object number does not exist |
|
55222 |
VALIDATION ERROR |
400 |
Value not found |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 |
When a user provides invalid range parameters in the request body |
Value not found |
|
55223 |
VALIDATION ERROR |
400 |
Invalid data |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 |
When a user provides invalid range parameters in the request body |
Invalid data |
|
55255 |
VALIDATION ERROR |
400 |
Failed to upload the file |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 |
Failed due to an unexpected error |
Failed to upload file to object storage |
|
55256 |
VALIDATION ERROR |
400 |
Object in use |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 |
Delete is not allowed when an object is in use by another object |
Dependency exists in Module <module name> |
|
55259 |
VALIDATION ERROR |
400 |
Multiple entities not supported |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 |
Bulk operation is not supported |
Cannot have <number of entries> entries with same tableNum and extraColumnName. Operation failed! |
|
55260 |
VALIDATION ERROR |
400 |
Invalid hierUnitId specified |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 |
The specified hierarchy unit ID is invalid. |
Invalid hierUnitId <hierUnitId> |
|
55262 |
VALIDATION ERROR |
400 |
No record found at the specified hierarchy |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 |
The requested operation cannot be performed at the specified hierarchy since no record exists at that level |
<resource> does not exist |
|
55263 |
VALIDATION ERROR |
400 |
Invalid language configuration |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 |
Culture code must be unique. Only one Language Culture can be configured for each language record |
Duplicate language cultures configured |
System
| o:errorCode | Server Code (title) | HTTP Status (status) | Message (detail) | Type | Context | errorDetails |
|---|---|---|---|---|---|---|
|
55501 |
DB CONNECTION ERROR |
500 |
DB connection error |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1 |
When the system is not able to connect to the database |
|
|
55503 |
SERVICE UNAVAILABLE |
503 |
Service Unavailable |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4 |
When the API service is unavailable to the user |
|
|
55504 |
INTERNAL SERVER ERROR |
500 |
Internal Server Error |
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1 |
When any other internal error occurs during request processing |
Contact the support team. An Exception occurred in transaction Id: <<transaction ID>> |