Response codes

Successfull HTTP status codes

  • 200OK
    The request is processed and the result is returned in the response body.

    Body

    Objectapplication/json

Failed HTTP status codes

  • 400Bad request
    The request is invalid due to wrong parameters.

    Body

    An error message

    How to fix

    Ensure that required parameters are provided with correct type.

  • 401Unauthorized
    The authentication failed.

    Body

    An error message

    How to fix

    Ensure to provide a valid session ID and/or a well formed authorization header.

  • 405Method Not Allowed
    The submitted request / endpoint does not exist.

    Body

    An error message

    How to fix

    Ensure that the URL request is correct, called with the correct method, with required parameters if any.

  • 406Not Acceptable
    The body request is not in JSON.

    How to fix

    Ensure to encode the fields in JSON and/or define the application/json content type in the header.

Other HTTP status codes

The API web server can return also all kind of HTTP codes for errors. Learn more about http codes