HTTP Status Codes and Error Handling
Every API call returns the following in response in the case of either success or failure:
>an HTTP status code that indicates whether a specific HTTP request has been successfully completed or not.
>a response body containing the request status. In the case of an error, the response body also contains an error code and an error message.
|
Error codes |
Description |
HTTP Status Codes |
|---|---|---|
|
2001 |
This web service version is not supported |
406 Not Acceptable |
|
2002 |
User is invalid |
400 Bad request |
|
2003 |
Customer is invalid |
400 Bad request |
|
2004 |
Units are not supported with limited concurrency - Per User. |
403 Forbidden |
|
2007 |
Invalid parameter: vendorId |
400 Bad request |
|
2008 |
Value of feature name passed in the input parameter is invalid. |
400 Bad request |
|
2009 |
Request from this vendorID is not supported |
401 Unauthorized |
|
2010 |
Invalid parameter: featureVersion |
400 Bad request |
|
2011 |
The request XML is not well formed |
400 Bad request |
|
2012 |
Not authorized to process any request |
403 Forbidden |
|
2013 |
license sessionId is invalid |
400 Bad request |
|
2014 |
Value of usage count passed in input parameter is invalid. Valid range is 1 to 2147483647 |
400 Bad request |
|
2015 |
Internal error |
403 Forbidden |
|
2018 |
License is expired |
403 Forbidden |
|
2019 |
License is disabled |
403 Forbidden |
|
2021 |
Maximum concurrent user limit reached |
403 Forbidden |
|
2022 |
Maximum usage count reached |
403 Forbidden |
|
2023 |
License does not exist or license is not in active state |
403 Forbidden |
|
2024 |
Invalid parameter |
403 Forbidden |
|
2025 |
Session terminated |
403 Forbidden |
|
2026 |
Access denied to the requested feature |
403 Forbidden |
|
2027 |
Authentication failed. Please check secret key, secret key id, vendor id, and hash computation. |
401 Unauthorized |
|
2028 |
Authorization header not found |
401 Unauthorized |
|
2029 |
x-sfnt-date header not found |
401 Unauthorized |
|
2030 |
Value of unitsRequired passed in input parameter is invalid. Valid range is 1 to 2147483647 |
400 Bad request |
|
2031 |
No authorization server mapped to given vendorId |
403 Forbidden |
|
2032 |
Maximum usage count reached |
403 Forbidden |
|
2033 |
Invalid parameter: dateHeader |
401 Unauthorized |
|
2034 |
Authentication Failed due to time mismatch |
401 Unauthorized |
Common Error Codes
| Error Code | Description | Status Code |
|---|---|---|
|
2001 |
This web service version is not supported |
406 Not Acceptable |
|
2009 |
Request from this vendorID is not supported |
401 Unauthorized |
|
2011 |
The request XML is not well formed |
400 Bad request |
|
2012 |
Not authorized to process any request |
403 Forbidden |
|
2015 |
Internal error |
403 Forbidden |
|
2024 |
Invalid parameter |
403 Forbidden |
|
2027 |
Authentication failed. Please check secret key, secret key id and vendor id |
401 Unauthorized |
|
2028 |
Authorization header not found |
401 Unauthorized |
|
2029 |
x-sfnt-date header not found |
401 Unauthorized |
|
2033 |
Invalid parameter: dateHeader |
401 Unauthorized |
|
2034 |
Authentication Failed due to time mismatch |
401 Unauthorized |