Generic reponses
All responses from our API will contain the following fields. These will enable the user to check whether the request was successful. Then, further information depending on the endpoint will be included.
Last updated
All responses from our API will contain the following fields. These will enable the user to check whether the request was successful. Then, further information depending on the endpoint will be included.
Last updated
Parameter
Type
Required
Description
code
text
True
HTTP code description. Possible values are: success, notAuthorized, notFound, serverError, badRequest, missingParameter, invalidInput, invalidField
http_code
int
True
HTTP response code. Possible values: 200, 201, 400, 403, 404, 422, 500
message
text
No
Message including the result
error
text
No
Error message if it exists