Contents x
    Response & Error information
    • 16 Aug 2022
    • 1 Minute to read
    • Print
    • PDF
    Contents

    Response & Error information

    • Updated on 16 Aug 2022
    • 1 Minute to read
    • Print
    • PDF
    Article summary

    All API requests will be served with one of the following status codes.

    Where appropriate we will return the keys "data" and "error" with more information about the result of your request. If populated the "data" key will contain the confirmation of the altered/inserted data and "error" will contain an array of issues with your request.

    Note: an empty "error" key does not indicate an error, if we return a json response it will always be populated with the "data" and "error" keys.

    Example Error Response

    {
        "data" : {},
        "error" : [
            "Insufficient Job Credits"
        ]
    }


    Possible HTTP response codes

    Code

    Description  

    200Success
    201Created (Success)
    204Success

    400

    Validation Failed / Insufficient Job Credits

    401 

    Unauthorised ( API key required / API Source key required )

    403

    An Enhanced / Premium Service Subscription is Required to access (only applicable for Care Homes, Nursery or Home Care Agency or if a Partner posting on behalf of a Care Home, Nursery or Home Care Agency )

    404 

    Not found

    405

    Method Not Allowed

    500Server Error ( something went wrong with our API )
    Was this article helpful?
    What's Next