<back to all web services
Status
The following routes are available for this service:| GET | /status | Gives the server time, status and version of the api | |
|---|
Status Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ShowVersionHistory | query | Boolean | No | Shows the version history of the api, including a short description of which changes are made in every version. If no value us provided, the default value is: FALSE |
Generic Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ApiKey | form | String | Yes | Api-key. Used to provide credentials to the api. Can also be provided through the request headers with key: X-API-KEY |
| OnlyPayload | form | Boolean | No | Normally the result of the request is put inside a resultobject with some status information about the request. If you want the output as csv this outer object can be irritating. Default value: FALSE |
| ShowRequest | form | Boolean | No | Show the request as interpreted by the api. Useful to see how filters / dates are parsed. If no value us provided, the default value is: FALSE |
| DateTimeFormat | form | Enum | No | Format all DateTime in the response object. If used in browser, sometimes ISO8601 is not correctly transformed. Enum options: ISO8601 (DEFAULT), UTC, NL, NLOffset, Unix, UnixMillis |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
HTTP + XML
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
POST /xml/oneway/Status HTTP/1.1
Host: data.smartdatasolutions.nl
Content-Type: application/xml
Content-Length: length
<Status xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SDS.Backend.APIs.DataApi.DTO.Request">
<ApiKey>String</ApiKey>
<DateTimeFormat>ISO8601</DateTimeFormat>
<OnlyPayload>false</OnlyPayload>
<ShowRequest>false</ShowRequest>
<ShowVersionHistory>false</ShowVersionHistory>
</Status>