RESTful API Status Codes
    • PDF

    RESTful API Status Codes

    • PDF

    Article summary

    The HTTP status codes returned in the Britive API responses are given in the following table:

    HTTP Status Code
    Description
    201 Created

    The requested resource is successfully created.

    For example, this response status is returned when an application is created.

    204 No ContentThe response does not have any content in the body.
    207 Multi -StatusThe response provides status for multiple processes.
    400 Bad Request

    Incorrect input parameter. 

    The error message provides more details about the error.

    401 UnauthorizedInvalid credentials or session timeout.
    403 ForbiddenAccess is denied.
    404 Not FoundThe information is not found.
    405 Method Not Allowed    The resource doesn't support the specified HTTP verb.
    422 Unprocessable EntityThe request can not be processed.
    500 Internal Server Error    The servers are not working as expected. The request is probably valid but needs to be given again later.
    503 Service Unavailable    The service is unavailable.

    Error Messages in Response

    Error messages are returned in REST API responses when there are wrong configurations or when invalid data are provided in the request. 

    For example, the following error message is displayed when you update the properties of an application that does not exist, giving the HTTP status code "400 Bad Request". 

    {
        "status": 400,
        "message": "App id '62hnp3zkv5jx1p8k74zj' does not exist.",
        "errorCode": "A-0003",
        "details": null
    }
    You can also notice the error code associated with this request. Depending on the case of error, a different error code is returned for each HTTP status code. For more information about each error code, see RESTful API Error Codes.



    Was this article helpful?