General Usage Product API
Overview Authentication Versioning Pagination Error Code Status
Error Code Table

Error Code Information

Below you can find the error code format that is returned for you. You will find all of the information you need in this return statement:

        {
            "errors": [
                {
                    "id": id of error,
                    "status": the status code of the error,
                    "code": the error code,
                    "title": the error title,
                    "detail": the description of the error,
                    "source": {
                        the cause of the error
                    }
                }
            ]
        }
        

Error Code Table

This table provides more information on the specific error code that has been returned to you.

Error Status Code Error Code Error Message Description
422 RequestValidationError Request Field Failed Validation A field in the resource you have sent is invalid, to fix this please look at the description of the error response. More information on this is available here.
422 PathValidationErrorResponse Path parameter failed validation The parameter in the path that you have passed in for the entity is not in the correct format.
401 UnauthorizedException Unauthorized Access to Resource You do not have the correct authorisation for this. Please check the token you are sending with your request.
403 ForbiddenAccessException Forbidden Access to Resource You do not have the correct permission to access this resource.
404 NotFoundError Unable to locate resource The entity you are trying to access cannot be find. Please review the entity id that you are sending in your request. This can be found in the error response detail.
409 ConflictRequestError Resource already exists This resource already exists, please use the get endpoint to view the entity.
400 EntityAfterIdDoesNotExistException Entity referenced in after id does not exist The entity id used in the param after_product_id does not exist, please use a different id.
400 MaxLimitNotMetException Maximum Limit Exceeded The limit query parameter provided for pagination exceeds the maximum limit.
400 MinLimitNotMetException Under Minimum Limit The limit query parameter provided for pagination in less than the minimum limit.
500 Exception Error occurred processing the request An error occurred, please speak to your THG escalation contact.
415 UnsupportedMediaTypeException Unsupported content-type header The only accepted content type is 'application/json'. Please ensure your request conforms to this content type.