Path: api/v1/test
This endpoint supports the following methods:
GET
Summary: Simple test api endpoint
Description: Can be used to check if authentication is working, the api endpoints are reachable, and that a suitable version of Jim2 is behind the API.
Response content
| Attribute | Type | Description |
|---|---|---|
| loggedOn | boolean | Returns true if the caller has logged on (ie Authentication header is valid). |
| loggedOnAs | string | Returns the cardcode of the logged on user if the authentication header is valid |
| version | object | Returns the system version information - this is only included if the authentication header is valid See the version section below. |
Attributes of the version object.
| Attribute | Type | Description |
|---|---|---|
| build | integer | |
| major | integer | |
| minor | integer | |
| release | integer |