Contact Us
Documentation

Parameter Mappings

API Overview

📘

PULS API Endpoints

📘

CTC API Endpoints

GetDevice API

Map to Smart Search API

PULS JSON PathCTC JSON PathCTC Sample Value
esnresponse.results.device.esn4562211953
firmwareVersionresponse.results.device.idReport.device.idReport.firmwareVersion85f
groupresponse.results.device.groups.[i].titleMinnesota
mobileIdTyperesponse.results.device.idReport.mobileIdType.id1
modemSelectionsresponse.results.device.idReport.modem.descriptionTelit LE910-SV LTE modem
ipAddressresponse.results.device.ipAddress
response.results.device.port		10.180.95.81
20510
mobileIdresponse.results.device.idReport.mobileId3271025936
imeiresponse.results.device.idReport.imei355144090222321
imsiresponse.results.device.idReport.imsi295050901338564
minresponse.results.device.idReport.min15333129309
vehicleClassresponse.results.device.idReport.vehicleClass0
scriptVersionresponse.results.device.idReport.scriptVersion33
configVersionresponse.results.device.idReport.configVersion16
unitStatusBit1-8response.results.device.idReport.unitStatus8

NOTE:
Bit 1: LMU32: HTTP OTA update status (0=OK, 1=error), LMU8: unused
Bit 2: GPS antenna status (0=OK, 1=error)
Bit 3: GPS receiver self-test (0=OK, 1=error) (LMU32 only)
Bit 4: GPS receiver tracking (0=Yes, 1=No)
Bit 5: VBus disabled due to errors
Bit 6: Reserved, currently unused
Bit 7: Reserved, currently unused
Bit 8: Unused
iccidresponse.results.device.idReport.iccid89883030000059070752
vehicleBus.esnresponse.results.device.esn4562211953
vehicleBus.mobileIdresponse.results.device.idReport.mobileId3271025936
vehicleBus.vbusPlatformresponse.results.device.idReport.device.idReport.standardExtensions.VBU3.platform

response.results.device.idReport.device.idReport.standardExtensions.JPOD2.platform

response.results.device.idReport.device.idReport.standardExtensions.OBD_TYPE_2.platform		101

3.0.0

2.0.0
vehicleBus.boardIdresponse.results.device.idReport.device.idReport.standardExtensions.VBU3.identifier

response.results.device.idReport.device.idReport.standardExtensions.JPOD2.identifier

response.results.device.idReport.device.idReport.standardExtensions.OBD_TYPE_2.identifier		105D8FF343439414B43217330
vehicleBus.lastErrorresponse.results.device.idReport.device.peripheralToHosts.[i].devicePeripheral.device.idReport.rawIdReport4,2.0.0,105D8FF343439414B43217330,V05.03.01.81,V01.03.01.43,,
vehicleBus.lastIdReportresponse.results.device.idReport.device.updateTime2022-01-01T16:40:12.866Z
vehicleBus.deviceTyperesponse.results.device.idReport.device.idReport.standardExtensions.VBU3.deviceType.id

response.results.device.idReport.device.idReport.standardExtensions.JPOD2.deviceType.id

response.results.device.idReport.device.idReport.standardExtensions.OBD_TYPE_2.deviceType.id		8
vehicleBus.lastIdReportTimeresponse.results.device.idReport.device.updateTime2022-01-01T16:40:12.866Z
imeiHexresponse.results.device.idReport.device.idReport.imeiHex001538EC8C000060ED
appIdresponse.results.device.idReport.appId241
customerNameresponse.results.device.account.titleCalAmp Solutions Group (CSG)
idReport.fileHashTable.rawFileTableresponse.results.device.idReport.device.idReport.fileTable.rawIdReport0,15,688F|0,0,D5E4|4,0,61A9|0,1,392D|4,4,2F51
idReport.fileHashTable.extensionPrefixresponse.results.device.idReport.device.idReport.fileTable.extensionPrefixFTBL
idReport.unknownExtensionsresponse.results.device.idReport.device.idReport.extensions"extensions": {
"VIN-INFO": [
"VIN-INFO:VIN=1234567890ABCDEFG,DEV-REGN=??,SRVR-REGN=??"
],
"AREV": [
"AREV:9948-ENG"
]
}
idReport.linuxFileReportresponse.results.device.idReport.device.idReport.standardExtensions
idReport.cellRadioIdReportresponse.results.device.idReport.device.idReport.standardExtensions.CELL_RADIO.rawIdReport14,53,354045090483097,0,02.002/01.000.02
idReport.extendedAppId.appIdresponse.results.device.idReport.device.idReport.extendedAppId.appId1001
idReport.extendedAppId.deviceType.nameresponse.results.device.idReport.device.deviceType.nameLMU
idReport.extendedAppId.extensionPrefixresponse.results.device.idReport.device.idReport.extendedAppId.extensionPrefixAID
idReport.parsedExtensions.CELL_RADIO.idReportresponse.results.device.idReport.device.idReport.standardExtensions.CELL_RADIO.rawIdReport14,53,354045090483097,0,02.002/01.000.02
idReport.parsedExtensions.CELL_RADIO.extensionresponse.results.device.idReport.device.idReport.standardExtensions.CELL_RADIO.extensionPrefixRADFW
idReport.parsedExtensions.CELL_RADIO.deviceType.nameresponse.results.device.idReport.device.idReport.standardExtensions.CELL_RADIO.deviceType.nameCELL_RADIO
idReport.parsedExtensions.CELL_RADIO.platformresponse.results.device.idReport.device.idReport.standardExtensions.CELL_RADIO.platform62
idReport.parsedExtensions.CELL_RADIO.identifierresponse.results.device.idReport.device.idReport.standardExtensions.CELL_RADIO.identifier55286081406395
idReport.parsedExtensions.CELL_RADIO.extensionPrefixresponse.results.device.idReport.device.idReport.standardExtensions.CELL_RADIO.extensionPrefixRADFW
idReport.peripheralsresponse.results.device.idReport.device.peripheralToHosts
idReport.supportedMacAlgorithm.supportedMacAlgorithmidReport.supportedMacAlgorithm.supportedMacAlgorithm1
idReport.supportedMacAlgorithm.extensionPrefixresponse.results.device.idReport.device.idReport.macAlgorithm.extensionPrefixMAC
idReport.otaCapability.protocolMapresponse.results.device.idReport.device.idReport.otaCapability.protocolMap{
"CELL_RADIO": {
"FTP": [{"name": "Firmware", "id": 0}]
},
"LMU": {
"HTTP": [
{"name": "DigitalSignatureKeys", "id": 18},
{"name": "CustomerConfig", "id": 1},
{"name": "SignatureKeysL2", "id": 19},
{"name": "Geozones", "id": 11},
...
idReport.otaStatus.otaId.deviceType.nameresponse.results.device.idReport.device.idReport.otaStatus.deviceType.nameLMU
idReport.otaStatus.fileType.CustomerConfigresponse.results.device.idReport.device.idReport.otaStatus.fileType.nameFirmware
idReport.otaStatus.statCoderesponse.results.device.idReport.device.idReport.otaStatus.statCode0
idReport.otaStatus.diagCoderesponse.results.device.idReport.device.idReport.otaStatus.diagCode0
idReport.otaStatus.diagStringresponse.results.device.idReport.device.idReport.otaStatus.diagString
idReport.version.versionresponse.results.device.idReport.device.idReport.firmwareVersion85f
idReport.mobileId.mobileIdresponse.results.device.idReport.mobileIdType.id4572103175
idReport.mobileIdTyperesponse.results.device.idReport.mobileIdType.descriptionESN
idReport.esnresponse.results.device.idReport.device.idReport.esn4572103175
idReport.minresponse.results.device.idReport.device.idReport.min
idReport.appid._idresponse.results.device.idReport.device.idReport.appId.extendedAppId.appId436
idReport.appid.idresponse.results.device.idReport.device.idReport.appId436
idReport.configVerresponse.results.device.idReport.device.idReport.configVersion25
idReport.scriptVerresponse.results.device.idReport.device.idReport.scriptVersion35
idReport.imeiresponse.results.device.idReport.device.idReport.imei355286081406395
idReport.imsiresponse.results.device.idReport.device.idReport.imsi295050900474721
idReport.iccIdresponse.results.device.idReport.device.idReport.iccid89883030000048291725
idReport.queryIdresponse.results.device.idReport.device.idReport.queryId0
idReport.vehicleClassresponse.results.device.idReport.device.idReport.vehicleClass0
idReport.modemSelection.idresponse.results.device.idReport.device.idReport.modemSelection62
idReport.unitstatus.bitmapresponse.results.device.idReport.device.idReport.unitStatus8
idReport.unitstatus.unitStatus1response.results.device.idReport.device.idReport.isUnitStatus1false
idReport.unitstatus.gpsantennaStatusOKresponse.results.device.idReport.device.idReport.isGPSAntennaStatusOKfalse
idReport.unitstatus.gpsreceiverTestOKresponse.results.device.idReport.device.idReport.isGPSReceiverTestOKfalse
idReport.unitstatus.gpstrackingOKresponse.results.device.idReport.device.idReport.isGPSTrackingOKfalse
idReport.gpsexceptionReportedresponse.results.device.idReport.device.idReport.isGPSExceptionReportedfalse
idReport.unitstatus.bit8Okresponse.results.device.idReport.device.idReport.isBit8Okfalse
idReport.vbusIdReportresponse.results.device.idReport.device.peripheralToHosts.[i]"peripheralToHosts": [{
"devicePeripheral": {
"firstIdReportTime": "2022-05-17T21:58:39.186Z",
"deviceType": {"name": "VBU3", "id": 25},
"deviceIdent": "000f00243437511038373734",
"device": {
"idReportRaw": "VBUS:25,101,000f00243437511038373734",
"updateTime": "2022-05-18T22:12:30.627Z",
"deviceType": {"name": "VBU3", "id": 25},
"deviceIdent": "000f00243437511038373734",
"idReport": {
"deviceType": { "name": "VBU3", "id": 25},
"platform": "101",
"identifier": "000f00243437511038373734",
"rawIdReport": "25,101,000f00243437511038373734,0,3.10.0.10.0.eb9c998",
"extensionPrefix": "VBUS"
}
},
"platform": {
"value": "VBU3 appid 101",
"id": 16,
"description": "VBus Platform "VBU3 appid 101""
}}}],
idReport.vbusIdReport.fileVersionMap.CustomerConfigresponse.results.device.idReport.device.idReport.standardExtensions.JPOD2.rawIdReport8,3.0.0,2001A002F3237471832353537,0,V01.86.43_13f_1.4.6288,1,000
idReport.vbusIdReport.fileVersionMap.Firmwareresponse.results.device.idReport.device.idReport.standardExtensions.VBU3.rawIdReport

response.results.device.idReport.device.idReport.standardExtensions.JPOD2.rawIdReport

response.results.device.idReport.device.idReport.standardExtensions.OBD_TYPE_2.rawIdReport		25,101,000f00243437511038373734,0,3.10.0.10.0.eb9c998

8,3.0.0,2001A002F3237471832353537,0,V01.86.43_13f_1.4.6288,1,000

4,2.0.0,105D7FF3635334D5043217317,V01.03.01.86,V01.03.01.43,,
idReport.vbusIdReport.rawReportresponse.results.device.idReport.device.idReport.standardExtensions.VBU3.rawIdReport

response.results.device.idReport.device.idReport.standardExtensions.JPOD2.rawIdReport

response.results.device.idReport.device.idReport.standardExtensions.OBD_TYPE_2.rawIdReport		8,3.0.0,2001A002F3237471832353537,0,V01.86.43_13f_1.4.6288,1,000
idReport.haidReport.rawReportresponse.results.device.idReport.standardExtensions.HOSTED_APP.rawIdReport250,,21,01.02.53
idReport.haidReport.deviceType.nameresponse.results.device.idReport.standardExtensions.HOSTED_APP.deviceType.nameHOSTED_APP
idReport.haidReport.extensionPrefixresponse.results.device.idReport.standardExtensions.HOSTED_APP.extensionPrefixHA
idReport.vinInfoStatusresponse.results.device.idReport.device.idReport.extensions.VIN-INFO.[i]VIN-INFO:VIN=1GNKRGED2CJ343269,DEV-REGN=US,SRVR-REGN=US
idReport.deviceServices.services.typeIdresponse.results.device.idReport.deviceServices.services.[i].typeId1
idReport.deviceServices.services.stateresponse.results.device.idReport.deviceServices.services.[i].state1
idReport.deviceServices.services.infoListresponse.results.device.idReport.deviceServices.services.[i].infoList1.2,"WILDCARD"
idReport.deviceServices.services.infoListStringresponse.results.device.idReport.deviceServices.services.[i].infoList1.2,"WILDCARD"
idReport.deviceServices.services.serviceConfigVersionresponse.results.device.idReport.deviceServices.services.[i].serviceConfigVersion
idReport.imeiHexresponse.results.device.idReport.device.idReport.imeiHex001538EC8C000060ED
idReport.vinresponse.results.device.idReport.vinInfoList.[i].vin19XZE4F52LE013752
firstIdReportTimeresponse.results.device.idReport.firstIdReportTime2021-10-19T22:42:45.241Z
lastIdReportTimeresponse.results.device.extensions.idReportTimestamp2022-01-01T16:40:12.866Z

Map to Shipping Info API

PULS JSON PathCTC JSON PathCTC Sample Value
shipping.trackingNumShipTracking1Z90X7Y50340566629
shipping.shippedDateShipDate2020-11-17 00:00:00-08

Map to Current Device File API

PULS JSON PathCTC JSON PathCTC Sample Value
configGroup[i].newDeviceFile.version
[i].transactionStatus.name
[i].lastUpdateTime		V01.03.01.43
SUCCESS
2021-12-21T21:29:04.127Z
vehicleBus.vbusDeviceFiles[i].newDeviceFile.version
[i].transactionStatus.name
[i].lastUpdateTime		V01.03.01.43
SUCCESS
2021-12-21T21:29:04.127Z
configStatus[i].transactionStatus.nameSUCCESS
firmwareStatus[i].transactionStatus.nameSUCCESS
firmwareHistorys.newFirmware.appId[i].newDeviceFile.platforms.[j].value416
firmwareHistorys.newFirmware.versionNumber[i].newDeviceFile.version85c
firmwareHistorys.oldFirmware.appId[i].oldDeviceFile.platforms.value416
firmwareHistorys.oldFirmware.versionNumber[i].oldDeviceFile.version85c
firmwareHistorys.status[i].commandResult.statusSUCCESS
firmwareHistorys.downloadRetryCount[i].commandResult.transactionStatus.retries1
firmwareHistorys.downloadRequestTime[i].requestTime2021-05-13T17:17:31.981Z
firmwareHistorys.lastUpdateTime[i].lastUpdateTime2021-05-13T17:27:37.165Z
lastConfigUpdateTime[i].lastupdateTime2020-12-09T17:27:04.414Z

Map to Device File History API

PULS JSON PathCTC JSON PathCTC Sample Value
vehicleBus.vbusFileHistories[i].newDeviceFile.version
[i].transactionStatus.name
[i].lastUpdateTime		V01.03.01.43
IN_PROGRESS
2021-12-21T21:26:44.194Z

GetVBus API

Map to Smart Search API

PULS JSON PathCTC JSON PathCTC Sample Value
esnresponse.results.device.esn4562211953
mobileIdresponse.results.device.idReport.mobileId3271025936
firstIdReportTimeresponse.results.device.idReport.device.peripheralToHosts.[i].devicePeripheral.firstIdReportTime2021-12-21T16:43:29.613Z
lastIdReportTimeresponse.results.device.idReport.device.peripheralToHosts.[i].devicePeripheral.device.updateTime2022-01-01T16:40:12.866Z
vbusPlatformresponse.results.device.idReport.device.peripheralToHosts.[i].devicePeripheral.device.idReport.platform2.0.0
boardIdresponse.results.device.idReport.device.peripheralToHosts.[i].devicePeripheral.deviceIdent105D8FF343439414B43217330
boardSerialNumberresponse.results.device.idReport.device.peripheralToHosts.[i].devicePeripheral.device.idReport.identifier105D8FF343439414B43217330
lastErrorresponse.results.device.idReport.device.peripheralToHosts.[i].devicePeripheral.device.idReport.rawIdReport4,2.0.0,105D8FF343439414B43217330,V05.03.01.81,V01.03.01.43,,
lastIdReportresponse.results.device.extensions.idReportTimestamp2022-01-01T16:40:12.866Z

Map to Device File History API

PULS JSON PathCTC JSON PathCTC Sample Value
vbusFileHistories[i].newDeviceFile.version
[i].transactionStatus.name
[i].lastUpdateTime		V01.03.01.43
IN_PROGRESS
2021-12-21T21:26:44.194Z

Map to Current Device File API

PULS JSON PathCTC JSON PathCTC Sample Value
vbusDeviceFiles[i].newDeviceFile.version
[i].transactionStatus.name
[i].lastUpdateTime		V01.03.01.43
SUCCESS
2021-12-21T21:29:04.127Z

Updated 11 months ago

What’s Next
© 2023 CalAmp