Fleet Freedom
Main Site
Overview
WebSocket
JavaScript
Behaviours
Provisioning
Pictures
Reports
Events
Return to site

Provisioning API Reference

Download JSDoc Helper
version 4.3.0
© 2025 Trak iT Wireless Inc.
https://modem.fleetfreedom.com/prepare/providerConfigId?ghostId=ghostId&assetId=
https://modem.fleetfreedom.com/setup/
uniqueIdentifier/verificationCode

ProviderInfo keys

Info Key Explanation
EVENT_TIMEThe time of the event.
EVENT_CODEThe provider-specific event code.
EVENT_NAMEThe provider-specific event name. See for more information.
GPS_LATITUDELatitude in decimal degrees
GPS_LONGITUDELongitude in decimal degrees
GPS_ALTITUDEAltitude above sea-level
GPS_SPEEDSpeed measured by GPS fix differentiation
GPS_HEADINGDirection of travel
GPS_SATELLITESThe number of satellites used to obtain the GPS fix
GPS_FIX_TIMEDate/time stamp of the most recent GPS fix
GPS_FIX_STATUSStatus or validity of the GPS fix
GPS_DISTANCEDistance measured between two GPS fixes
GPS_ACCURACYThe approximate accuracy of the GPS fix
GPS_ODOMETERA virtual odometer accumulated by the GPS system's positions
GPS_ANTENNA_STATUSGPS antenna status could be related to power or unplugged states
GPS_HDOPHorizontal dilution of precision for 3D fixes
GPS_ACCELERATIONA virtual accelerometer calculated by the GPS system's positions
GPS_DECELERATIONA virtual accelerometer calculated by the GPS system's positions
GPS_LOST_TIMEDate/time stamp from when the device lost GPS signal
PERCENT_LOST_GPSDate/time stamp from when the device lost its precise GPS position
PERCENT_LOST_GPS_QUALITY_FACTORStatistical amount of bad GPS data
MAGNETIC_VARIATIONDifference in horizontal angle between true north and magnetic north
COURSEThe heading or bearing over time.
GEOFENCE_IDID of violated geofence
GEOFENCE_VIOLATIONGeofence violation types(outside fence violation, inside fence violation)
DIGITAL_INPUT_0Digital input wire zero, or external power, or internal battery power
DIGITAL_INPUT_1Digital input wire #1
DIGITAL_INPUT_2Digital input wire #2
DIGITAL_INPUT_3Digital input wire #3
DIGITAL_INPUT_4Digital input wire #4
DIGITAL_INPUT_5Digital input wire #5
DIGITAL_INPUT_6Digital input wire #6
DIGITAL_INPUT_7Digital input wire #7
DIGITAL_INPUT_8Digital input wire #8
DIGITAL_INPUT_9Digital input wire #9
DIGITAL_INPUT_10Digital input wire #10
DIGITAL_INPUT_11Digital input wire #11
DIGITAL_OUTPUT_0Voltage output wire #0
DIGITAL_OUTPUT_1Voltage output wire #1
DIGITAL_OUTPUT_2Voltage output wire #2
DIGITAL_OUTPUT_3Voltage output wire #3
DIGITAL_OUTPUT_4Voltage output wire #4
DIGITAL_OUTPUT_5Voltage output wire #5
DIGITAL_OUTPUT_6Voltage output wire #6
DIGITAL_OUTPUT_7Voltage output wire #7
DIGITAL_OUTPUT_8Voltage output wire #8
DIGITAL_OUTPUT_9Voltage output wire #9
DIGITAL_OUTPUT_10Voltage output wire #10
DIGITAL_OUTPUT_11Voltage output wire #99
DIGITAL_INPUT_RTSLegacy AirLink digital input wire #1
DIGITAL_INPUT_DTRLegacy AirLink digital input wire #2
ANALOG_INPUT_0Analog voltage reading from wire zero, or external power voltage, or internal battery voltage
ANALOG_INPUT_1Analog voltage reading from wire #1
ANALOG_INPUT_2Analog voltage reading from wire #2
ANALOG_INPUT_3Analog voltage reading from wire #3
ANALOG_INPUT_4Analog voltage reading from wire #4
ANALOG_INPUT_5Analog voltage reading from wire #5
ANALOG_INPUT_6Analog voltage reading from wire #6
ANALOG_INPUT_7Analog voltage reading from wire #7
ANALOG_INPUT_8Analog voltage reading from wire #8
ANALOG_INPUT_9Analog voltage reading from wire #9
ANALOG_INPUT_10Analog voltage reading from wire #10
ANALOG_INPUT_11Analog voltage reading from wire #11
GPIO0Switchable input/output wire zero, or external power, or internal battery
GPIO1Switchable input/output wire #1
GPIO2Switchable input/output wire #2
GPIO3Switchable input/output wire #3
GPIO4Switchable input/output wire #4
GPIO5Switchable input/output wire #5
GPIO6Switchable input/output wire #6
GPIO7Switchable input/output wire #7
GPIO8Switchable input/output wire #8
GPIO9Switchable input/output wire #9
STATUS_SLEEPLow power mode
STATUS_WAKEUPHigh power mode
STATUS_POWERUPBooting
VINVehicle Identification Number
OBDII_PROTOCOLame or code of the OBD-II protocol in use.
OBDII_PARAMETERSList of OBD-II parameters
OBDII_INDICATORSList of OBD-II indicators
OBDII_DTCDiagnotic Trouble Code
OBDII_DTC_COUNTThe number of DTCs present
J1708_ODOMETEROdometer reading from J-Bus 1708
J1939_ODOMETEROdometer reading from J-Bus 1939
OBDII_ODOMETEROdometer reading from CAN-Bus
OBDII_MILES_SINCE_LAST_ALERTOdometer reading from CAN-Bus since last DTC code was cleared
ACCELEROMETERA virtual accelerometer calculated by the GPS system's positions
INTERNAL_TEMPERATURETemperature measured on the mainboard, or inside the modem casing.
EXTERNAL_TEMPERATURETemperature measured outside of the modem casing.
MOTION_STATUSMotion status determined by the GPS speed and ignition
ESNThe device's ESN (Electronic Serial Number).
IMEIThe device's IMEI (International Mobile Station Equipment Identity).
PHONE_NUMBERPhone number
SECONDARY_IMEIThe device's secondary IMEI.
IMSIThe device's IMSI (International Mobile Subscriber Identity).
MINThe device's MIN (Mobile Identification Number).
ICCIDThe device's ICCID (Integrated Circuit Card ID)
MODEM_NAMEDevice friendly name.
MODEM_MODELDevice model name.
MODEM_MODEL_IDDevice model name.
HARDWARE_VERSIONDevice model information.
SERIAL_NUMBERA serial not used as ESN, IMEI, or similar.
OS_NAMEOperating System name (appropriate for mobile phones powered by Android or iOS).
OS_VERSIONOperating System version information.
BOOT_VERSIONBoot or kernel version information.
GPS_HARDWAREGPS chip information.
APP_IDIdentifier of the application communicating with the service(s).
APP_VERSIONSoftware/firmware version information.
REGISTRATION_IDUnique string given to mobile apps for FCM notifications.
DRIVER_ONDUTYWhen the driver changes status to "on-duty" from another status.
DRIVER_OFFDUTYWhen the driver changes status to "off-duty" from another status.
DRIVER_DRIVINGWhen the driver changes status to "driving" from another status.
DRIVER_SLEEPINGWhen the driver changes status to "sleeping" from another status.
DRIVER_LOGOFFWhen the driver logs-off the terminal/vehicle.
DRIVER_LOGINWhen the driver logs-in the terminal/vehicle.
DRIVER_VEHICLEWhen the driver chooses a specific vehicle during the log-in process.
DISPATCH_TASKA task is marked as active or "on-route" when the DispatchTask.id is sent.
Trak iT® Wireless and Fleet Freedom® are Trademarks of Trak iT® Wireless Inc.
All content contained within this site is the property of Trak iT® Wireless unless otherwise stated.