Getting started

Every API end point requires a token parameter value passed as a header.

A token is acquired by executing a GetToken endpoint call.

GetToken returns a string value representing the Token. That token is valid for 12 hours, after which it is necessary to ackquire a new one.

GETTOKEN CALL EXAMPLE HERE

In addition to token, specific endpoints may require additional parameter values passed as headers.

Parameters must be passed in the order they are listed in.

Parameters must not be ommited unless default values are to be assumed for all of them.

EXAMPLE OF BAD CALL WITH OMMITED PARAMETERS

Here's a list of commonly appearing parameter names and their meanings:

• Limit - maximum number of records returned in the response. Default value is 0, in which case there is no limit (all records will be returned)
• Offset - number of records by which to shift the desired response. Default value is 0, in which case the result will not be shifted at all.
• SCN - a unique identifier representing the timestamp by which data state in the database can be identified. Default value is 0, in which case the result will contain the data state at the moment of API endpoint execution.