GET api/indafit/imeicheck?userID={userID}&token={token}&imei={imei}&vehicleReg={vehicleReg}

performs a check to see if the imei exists in the system. If it does, the vehicle reg is checked, a service is created and the device is bound to the newly created service

Request Information

URI Parameters

NameDescriptionTypeAdditional 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

vehicleReg

string

Required

Body Parameters

None.

Response Information

Resource Description

IndafitIMEICheckResponse
NameDescriptionTypeAdditional information
IMEI

the IMEI of the device

string

None.

DeviceID

device id of the supplied IMEI, or 0 if not valid

unsigned integer

None.

ValidIMEI

indicator to show if the supplied IMEI exists in the back end

boolean

None.

DeviceIsAvailable

indicates that the device is available to be assigned to a service. if it isn't, the installation cannot proceed

boolean

None.

ServiceID

service id of the supplied vehicle reg, or 0 if not valid

unsigned integer

None.

HasError

indicates if there was an error

boolean

None.

ErrorMessage

error message if an error occurs

string

None.

Response Formats

application/json, text/json

Sample:
{
  "IMEI": "sample string 1",
  "DeviceID": 2,
  "ValidIMEI": true,
  "DeviceIsAvailable": true,
  "ServiceID": 5,
  "HasError": true,
  "ErrorMessage": "sample string 7"
}

application/xml, text/xml

Sample:
<IndafitIMEICheckResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <IMEI>sample string 1</IMEI>
  <DeviceID>2</DeviceID>
  <ValidIMEI>true</ValidIMEI>
  <DeviceIsAvailable>true</DeviceIsAvailable>
  <ServiceID>5</ServiceID>
  <HasError>true</HasError>
  <ErrorMessage>sample string 7</ErrorMessage>
</IndafitIMEICheckResponse>