API

Specifications

Overview - Error

Edit Jira

Error codes are returned by all API endpoints when the answer is not HTTP-OK. They are displayed in by clicking the default button on the right side panel.

Error Message #

This is the structure of the error message:

1
2
3
4
5

{
    "name": "BAD_REQUEST",
    "debug": "ERROR_123456789",
    "message": "Invalid data provided."
}
  • name is a human-readable, unique name for the error. It should be mapped on the server side to ensure consistency.
  • debug is a unique error identifier generated on the server side and logged for correlation purposes. It starts with ERROR_.
  • message is a human-readable message describing the error. This message must be a description of the problem, not a suggestion about how to fix it.

Note: If you encounter any unexpected error, do not forget to save the error message. Please contact Stellantis support with the error message (name, debug and message), we will be able to investigate this.

HTTP Error Codes #

This table lists some HTTP error codes and their meaning in the context of this API.

Response Code Meaning
200 The request has succeeded and the resource data has been sent.
202 The request has been accepted for processing, but not yet acted upon. An id of processing is returned.
204 The request has been accepted and there is no additional content.
400 Request cannot be processed due to invalid query parameter value of body content (for POST/PUT verbs)
401 Unauthorized request due to lack of valid authentication credentials.
403 Unauthorized request due to insufficient credentials to grant access.
404 Target resource not found.
500 Unexpected condition that prevented from fulfilling the reques.
501 Feature not supported.