Client Error Responses

• 400 Bad Request
  • Description: The server could not understand the request due to invalid syntax. Check the response for more details.

Example:

{
  "status": "error",
  "message": "Bad request. Please check your input parameters."
}

• Scenario: This response is returned when the request parameters are incorrect or missing.
• 401 Endpoint Error | Unauthorized
  • Description: The client must authenticate itself to get the requested response or there is an endpoint error.

Example:

{
  "status": "error",
  "message": "Unauthorized. Please provide valid authentication credentials."
}

• Scenario: This response is returned when authentication is required and has failed or has not yet been provided, or there is an endpoint error.
• 404 Endpoint Not Found
  • Description: The server can not find the requested endpoint.

Example:

{
  "status": "error",
  "message": "Not found. The requested endpoint could not be found."
}

• Scenario: This response is returned when the requested endpoint is not found on the server.