GetDeviceStatus (...)

Introduction
Gets the health and connectivity status of the device in the install session, so an installer can check that the install worked before submitting it.
Call it any time after InitiateInstall and as often as needed; it does not need RegisterDevice and does not change the device. The response lists the last server communication, GPS and engine data times, SIM state, detected harness, connected IOX accessories (with the recorded configuration of each configurable module), GPIO readings (only after InitiateDevicePeripheralSetup, which needs RegisterDevice) and the service types accepted by LogService. Errors (error code): 5804 (invalid or expired install token), GenericError (the device or its status could not be retrieved), UnsupportedApiVersion.
Parameters

apiKey

The API key (user ID) of the authenticated caller, as returned by Authenticate. Send null when authenticating with a Bearer token.

includeIoxModuleStatus

Optional, default false. When true, each configurable IOX module in ioxDevices also gets a liveStatus: a live read of its modules and the current door states, so an integrator can verify door sensor wiring (close the doors, call, open the doors, call) and module health after a configuration. This is a round trip to the module through the customer's MyGeotab database, one per module. The vehicle ignition must be on, and each read can take up to about a minute when the module does not answer, so the call can take minutes with several modules. A read that fails or times out leaves liveStatus out; the call itself does not fail. When absent or false, nothing is sent to any module and the response is unchanged.

installToken

The install session token returned by InitiateInstall.

sessionId

The session ID of the authenticated caller, as returned by Authenticate. Send null when authenticating with a Bearer token.
Return value
Remarks
Call it any time after InitiateInstall and as often as needed; it does not need RegisterDevice and does not change the device. The response lists the last server communication, GPS and engine data times, SIM state, detected harness, connected IOX accessories (with the recorded configuration of each configurable module), GPIO readings (only after InitiateDevicePeripheralSetup, which needs RegisterDevice) and the service types accepted by LogService. Errors (error code): 5804 (invalid or expired install token), GenericError (the device or its status could not be retrieved), UnsupportedApiVersion.
Code samples

Loading API Runner...