Index

Test API

Path: api/v1/test

Method: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:

{
Returns true if the caller has logged on (ie Authentication header is valid).
"loggedOn":boolean
Returns the cardcode of the logged on user if the authentication header is valid
optional
"loggedOnAs":string
Returns the system version information - this is only included if the authentication header is valid
optional
"version":{
"major":integer
"minor":integer
"release":integer
"build":integer
}
}

Generated from Jim2 version 4.6.9450.57