GET api/indafit/installationcheck?userID={userID}&token={token}&imei={imei}
take the supplied service id and check the input status' for the installation check and return the values
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| userID |
The ID returned from a successful login |
unsigned integer |
Required |
| token |
The authentication token returned from a successful login |
string |
Required |
| imei | string |
Required |
Body Parameters
None.
Response Information
Resource Description
IndafitInstallationCheckResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| ServiceID |
service id of the vehicle being tested |
unsigned integer |
None. |
| PowerRestore |
flag showing if a power restore message has been recevied |
boolean |
None. |
| GPSOverSix |
flag showing if a gps signal with a strength over 6 has been received |
boolean |
None. |
| IgnitionOn |
flag showing if the ignition has been turned on (journey start message) |
boolean |
None. |
| Idle |
flag showing if an idle message has been recevied |
boolean |
None. |
| IgnitionOff |
flag showing if the ignition has been turned off (journey end message) |
boolean |
None. |
| NoPowerLossOverThreeMins |
flag showing if the vehicle has not suffered a power loss in more than the last three minutes |
boolean |
None. |
| AllGood |
Single point to check if all the parameters are true |
boolean |
None. |
Response Formats
application/json, text/json
{
"ServiceID": 1,
"PowerRestore": true,
"GPSOverSix": true,
"IgnitionOn": true,
"Idle": true,
"IgnitionOff": true,
"NoPowerLossOverThreeMins": true,
"AllGood": true
}
application/xml, text/xml
<IndafitInstallationCheckResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ServiceID>1</ServiceID> <PowerRestore>true</PowerRestore> <GPSOverSix>true</GPSOverSix> <IgnitionOn>true</IgnitionOn> <Idle>true</Idle> <IgnitionOff>true</IgnitionOff> <NoPowerLossOverThreeMins>true</NoPowerLossOverThreeMins> </IndafitInstallationCheckResponse>