Unless specified otherwise, all requests are in the JSON format, passed as raw POST data, in the UTF-8 format.
Currently, there is no special validation done for most of the input, so the necessary checks (such as validity of ID codes, e-mails etc) should be done on the API client side.
| Parameter | Type | Reqd | Description | Options |
|---|---|---|---|---|
| username | string | ● | Username | |
| password | string | ● | Password | |
| lang | string | Language code |
et -- estonian en -- english (default) lv -- latvian lt -- lithuanian ru -- russian de -- german fr -- french es -- spanish it -- italian pt -- portugese ro -- romanian pl -- polish |
|
| output | classifier | Output format |
json -- JSON (default) xml -- XML |
| Type | Description |
|---|---|
| string | String parameter |
| integer | Integer number |
| sum | Sum (in currency) |
| classifier | Value from the classifier list. Empty or missing for no value if not required. |
| list | Comma-separated list of classifier values. |
| boolean | 0 -- false / 1 -- true |
| date | Date value in the following format: DD.MM.YYYY |
The answer is returned in either JSON (default) or XML format, using the UTF-8 character set.
| Parameter | Type | Description |
|---|---|---|
| status | integer |
1 -- request successful 2 -- error processing request |
| error | string | Error message (if status=2) |
| apirequest_oid | integer | Request OID (for debugging purposes) |
In case of multiple error messages they are separated by the “ | “ sequence.
In the XML response, parameters of type "array" are enclosed in a tag which name is the name of the parameter in plural: if the response parameter is "person", then the in the XML it's enclosed in a tag named <persons>.
If the array is an associative array, then the array key is passed as the "id" attribute of each member element.