When performing a request the following headers can be stated
|Authorization||Authentication header in which all data related to the authentication are to be sent. The details are described in chapter Authentication.|
|X-User-Agent||This header allows the client/platform name and/or other related information to be determined.|
|X-User-Agent-Version||This header allows to determine the version of the client/platform making the request. Its content does not affect the functioning of the API.|
|X-Request-ID||This header allows to determine the request ID. It is useful in debugging errors and problems that can occur when integrating with the API. Its provision does not affect the functioning of the API.|
The header allows to change the error message format. Available:
In the response the server returns the following headers:
Request ID. Useful when debugging problems with the API.
|String||Absolute URL address to the collection.|
|Integer||Total number of collection elements.|
|Integer||Current collection results page.|
|Integer||Number of results (per page) returned in the response.|
Collection example in the JSON format:
Collections support paging (unless stated otherwise in the documentation applicable to the resource).
Scrolling on the subsequent collection pages is by providing parameters in the request (page) and/or (page_page). Sample request:
All requests sent to the server require provision of the right and valid access token which is property of the particular owner in the organization.
The access token should be provided in the Authorization header.
A list of error keys that can occur is provided below.
|The resource being sought has not been found.|
|Access to the particular resource is forbidden.|
|An incorrect value has been provided for the particular parameter in the URI. Details available under the error response description key.|
|Validation error. The data sent in the request body with the POST method are incorrect. The error details included in the response under the details key See the validation error example below.|
|The offer cannot be purchased, as its validity term has expired.|
Sample validation_failed error
In this case, Obit details contains a collection in which the keys correspond to the names of the parameters sent in the request body, while the values is a table with keys specifying the validation errors that have occurred for the particular parameter.
Possible validation errors are:
|The value for the particular parameter is required.|
|Too low number of characters. Check the details in the documentation for the particular resource.|
|Too high number of characters. Check the details in the documentation for the particular resource.|
|The entered value should be a number.|
|The entered value should be an integer.|
|The entered value is incorrect. Check the details in the documentation for the particular resource.|