Skip to main content
07399 456 959 admin@uconvert.co.uk

Response Errors
Last updated: December 07 2018 05:56 PM

The UConvert RESTful API uses standard HTTP response codes to indicate success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a required parameter was invalid), and codes in the 5xx range indicate an error with UConvert's servers.

Error Code Response

Name Description
type the error in error responses
status The HTTP status of the response.
code A specific UConvert error code. (see table below).
message A human-readable message describing the error.
help_url A URL that links to more information about why the error occurred.

Detailed Error Codes

Type Description
no_content 204 HTTP NO CONTENT
No Content The server successfully processed the request, though no content is returned.
invalid_parameter 400 HTTP BAD REQUEST
Invalid Parameter response happens when your request has invalid parameters.
invalid_parameter_values 400 HTTP BAD REQUEST
Invalid Parameter Values response happens when your request has invalid parameter values.
unknown_parameter 400 HTTP BAD REQUEST
Unknown Parameter response happens when your request has unknown parameters.
missing_parameter 400 HTTP BAD REQUEST
Missing Parameter response happens when your request has missing parameters.
property_id_mismatch 400 HTTP BAD REQUEST
Property Id Mismatch response happens when you have requested a resource that is not linked to your property id.
limit_exceeded 400 HTTP BAD REQUEST
Limit Exceeded response happens when use the query parameter limit and exceed our maximum limit of 50 items per page
not_found 404 HTTP NOT FOUND
Not Found response happens when all your parameters pass validation but we are unable to find any information on the requested resource.
invalid_credentials 401 HTTP UNAUTHORIZED
Unauthorised response happens when you have invalid credentials.
invalid_api_key 401 HTTP UNAUTHORIZED
Unauthorised response happens when you have supplied an invlid API Key.
condition_not_allowed 403 HTTP FORBIDDEN
Condition Not Allowed response happens when you are not allowed to use a particular condition in your request. As an example, you request product descriptions, when you don't have access to request them.

Example Request

Base URL

GET
v1/gift/{gift_id}/

400 HTTP BAD REQUEST - Error Response Example

{
 "type" : "error",
 "status" : "400",
 "code" : "unknown_parameter",
 "message" : "Gift category id (6234) does not exists",
 "help_url" : "https://uconvert.co.uk/api/v1/documentation/#all-gift-categories"
}