Responses

Content-Type

The API responds with Content-Type set to application/json, and with JSON content in the body.

Response codes

In case of success, the HTTP status code is normally 200 and the content contains the result according to the nature of the request. In case of error, there are multiple HTTP status codes for different types of errors.

• 200 OK

  • Success response. The content contains the result according to the nature of the request.

• 400 Bad Request

  • Error caused by the client app, e.g. in case of malformed request or invalid payload. In most cases, such an error signifies a bug in the client app (consumer of the API).

• 401 Unauthorized

  • Error caused by usage of invalid API Key and/or secret, or you may not have the necessary permission to use the endpoint.

• 403 Forbidden

  • Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.

• 404 Not found

  • The server cannot find the resource requested by the client app. Verify the URL and request method.

• 429 Too Many Requests

  • Error caused by too many requests sent in a given amount of time.

• 500 Internal Server Error and other 5xx response codes

  • Unexpected error on the Fullwhere API side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified.