Error reference
This document provides an overview of the various types of errors that can be encountered when using the Sync API operations. It aims to help developers understand and handle errors effectively during their interactions with the API.
When interacting with the Sync API, it is crucial to be aware of the possible error scenarios that may occur. These errors can be informative indicators of issues or unexpected behaviors during API requests and responses. By understanding the types of errors and their meanings, developers can implement appropriate error handling and troubleshooting mechanisms in their applications.
Error types
The Sync API may return different types of errors depending on the nature of the problem encountered. These errors can include:
Authentication Errors: These errors occur when there are issues with the authentication and authorization processes. For example, if the provided API key is invalid or not provided, the API may return an authentication error.
Validation Errors: Validation errors are encountered when the request data does not meet the required criteria or constraints. This can include missing or incorrect parameters, invalid formats, or out-of-range values. The API responds with validation errors to prompt the correction of the submitted data.
Rate Limiting Errors: To maintain system stability and fairness, the Sync API may impose rate limits on the number of requests that can be made within a specific time period. Rate limiting errors occur when the rate limits are exceeded, and the API temporarily restricts further requests from the client.
Server Errors: Server errors indicate issues on the API server side that prevent the successful processing of a request. These errors can range from temporary service disruptions to more persistent technical problems. When server errors occur, it is advisable to retry the request later or contact the API provider for further assistance.
Errors
The API can return a variety of errors in different situations. Below are some common errors you may encounter when interacting with the API. These errors are grouped into categories for better understanding.
Core API errors
These are fundamental errors related to authentication, authorization, and API limits.
| Error type | Error detail | Description |
|---|---|---|
| unauthorize (401) | Unauthorize | The requester is not allowed to use this request. |
| forbidden (403) | Forbidden | Authorization header is invalid or was not provided. |
| forbidden (403) | RateLimitExceeded | The maximum number of requests or quota allowed within a specified time period has been exceeded. |
| tooManyRequests (429) | TooManyRequests | The rate limits for the requests have been exceeded. Please retry the request after a certain period of time. |
Common request errors
These are some of the common errors related to the requests sent to the API.
| Error type | Error detail | Description |
|---|---|---|
| badRequest (400) | BadRequest | The request is missing a required parameter. |
| badRequest (400) | BadParameters | The request contains invalid or unsupported parameters. |
| badRequest (400) | PlateNotFound | The state of the given vehicle plate could not be found. |
Server errors
These errors are related to server-side issues or unexpected errors that occur during the processing of the request.
| Error type | Error detail | Description |
|---|---|---|
| internalServerError (500) | InternalServerError | An unexpected error occurred on the server. Please contact the administrator for assistance. |
In the response body of the 500 error, a property named traceId may be included. This traceId contains an error identifier used by the Sync API developers to easily identify the problem and resolve it more efficiently. If you encounter a 500 error, it can be helpful to provide the traceId to the API support team to assist them in investigating and resolving the issue promptly.