Response

The API responds with Content-Type set to application/json and JSON content. In case of success, the HTTP status code is 200 or 201, and the content contains result according to the call. In case of error, there are multiple HTTP status codes for different types of errors:

  • 400 Bad Request

    • Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. 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 gvd-key-id, gvd-key-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

    • Error happens when the server could not find the requested resource. It means that the web page or resource you're trying to access does not exist on the server or cannot be located at the specified URL.

  • 422 Unprocessable Content

    • Error happens when the request body or query params do not pass the validation from server.

  • 429 Too Many Requests

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

  • 500 Internal Server Error

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

  • 503 Service Unavailable

    • The server is not ready to handle the request. Common causes are a server that is down for maintenance or that is overloaded.

PreviousRequestNextVersioning

Last updated