Errors
When working with the API, requests may sometimes fail due to incorrect input, invalid authentication, or internal server issues. To make troubleshooting easier, the ADManager Plus API returns errors in a consistent format.
Each error response includes:
- Error code: A unique identifier for the issue.
- Title: A short label describing the error type.
- Description: A detailed explanation of the problem.
{
"error": {
"code": <error code>
"detail": <error message>
"title": <title>
}
}
ADManager Plus error codes
When using the ADManager Plus API, you may encounter various error codes that indicate specific issues encountered during the request process. These error codes are designed to provide clear and concise information about the nature of the problem, allowing you to take appropriate action to resolve it.
Client errors
These occur when the request sent to the API is invalid or cannot be processed due to issues on the client side.
| Error code | Title | Description |
|---|---|---|
| 00000100 | Bad Request | The server could not process the request due to client-side issues such as malformed syntax, invalid formatting, or incorrect request routing. |
| 00000101 | Unauthorized | The request contained an invalid or missing token. |
| 00000102 | Unprocessable Content | The request was well-formed but contained semantic errors that prevented it from being processed. |
| 00000103 | Unsupported Media Type | The media format of the requested data is not supported by the server, so the request is rejected. |
| 00000104 | Page Not Found | The requested endpoint does not exist or is not supported. |
| 00000105 | Unsupported HTTP Method | The HTTP method used is not supported for the requested endpoint. |
| 00000106 | Forbidden | The client is authenticated but does not have permission to access the resource. Unlike 401 Unauthorized, the server recognizes the client’s identity. |
| 00000107 | Invalid Parameter | One or more input parameters are invalid or unacceptable for the operation being performed. |
| 00000108 | Content Length is Required | The request was rejected because the Content-Length header was missing, and the server requires it. |
| 00000109 | Too Many Requests | The client has exceeded the allowed rate limit for requests. Please retry after some time. |
| 00010104 | Invalid Attribute Found | The fields or sort attribute specified in the request contains invalid values. |
| 09000001 | Invalid Input Data | The input data in the request is missing, incomplete, or does not meet the required format. |
Server errors
These occur when something goes wrong on the server while processing a valid request.
| Error code | Title | Description |
|---|---|---|
| 00000000 | Internal Server Error | An unexpected error occurred on the server. Please try again later. |