API Overview

📘
PULS API Endpoints

GET Device: https://puls.calamp.com/service/device/{esn}?apikey={PULS_API_KEY}

GET VBus: https://puls.calamp.com/service/vbus/{esn}?apikey={PULS_API_KEY}

📘
CTC API Endpoints

POST Smart Search: https://connect.calamp.com/device-services/devices/smartsearch?include=groups&withIdReport=true&withCredentials=true&withLocation=true&expand=deviceConfiguration&v=2.1&pg=1&pgsize=10&sort=+name

GET Shipping Info: https://connect.calamp.com/device-services/devices/{esn}/shippinginfo

GET Current Device File: https://connect.calamp.com/device-services/devices/{esn}/filehistory/current

GET Device File History: https://connect.calamp.com/device-services/devices/{esn}/filehistory

GetDevice API

GetDevice API

Map to Smart Search API

PULS JSON Path	CTC JSON Path	CTC Sample Value
esn	response.results.device.esn	4562211953
firmwareVersion	response.results.device.idReport.device.idReport.firmwareVersion	85f
group	response.results.device.groups.[i].title	Minnesota
mobileIdType	response.results.device.idReport.mobileIdType.id	1
modemSelections	response.results.device.idReport.modem.description	Telit LE910-SV LTE modem
ipAddress	response.results.device.ipAddress response.results.device.port	10.180.95.81 20510
mobileId	response.results.device.idReport.mobileId	3271025936
imei	response.results.device.idReport.imei	355144090222321
imsi	response.results.device.idReport.imsi	295050901338564
min	response.results.device.idReport.min	15333129309
vehicleClass	response.results.device.idReport.vehicleClass	0
scriptVersion	response.results.device.idReport.scriptVersion	33
configVersion	response.results.device.idReport.configVersion	16
unitStatusBit1-8	response.results.device.idReport.unitStatus	8 *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
iccid	response.results.device.idReport.iccid	89883030000059070752
vehicleBus.esn	response.results.device.esn	4562211953
vehicleBus.mobileId	response.results.device.idReport.mobileId	3271025936
vehicleBus.vbusPlatform	response.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.boardId	response.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.lastError	response.results.device.idReport.device.peripheralToHosts.[i].devicePeripheral.device.idReport.rawIdReport	4,2.0.0,105D8FF343439414B43217330,V05.03.01.81,V01.03.01.43,,
vehicleBus.lastIdReport	response.results.device.idReport.device.updateTime	2022-01-01T16:40:12.866Z
vehicleBus.deviceType	response.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.lastIdReportTime	response.results.device.idReport.device.updateTime	2022-01-01T16:40:12.866Z
imeiHex	response.results.device.idReport.device.idReport.imeiHex	001538EC8C000060ED
appId	response.results.device.idReport.appId	241
customerName	response.results.device.account.title	CalAmp Solutions Group (CSG)
idReport.fileHashTable.rawFileTable	response.results.device.idReport.device.idReport.fileTable.rawIdReport	0,15,688F\|0,0,D5E4\|4,0,61A9\|0,1,392D\|4,4,2F51
idReport.fileHashTable.extensionPrefix	response.results.device.idReport.device.idReport.fileTable.extensionPrefix	FTBL
idReport.unknownExtensions	response.results.device.idReport.device.idReport.extensions	"extensions": { "VIN-INFO": [ "VIN-INFO:VIN=1234567890ABCDEFG,DEV-REGN=??,SRVR-REGN=??" ], "AREV": [ "AREV:9948-ENG" ] }
idReport.linuxFileReport	response.results.device.idReport.device.idReport.standardExtensions
idReport.cellRadioIdReport	response.results.device.idReport.device.idReport.standardExtensions.CELL_RADIO.rawIdReport	14,53,354045090483097,0,02.002/01.000.02
idReport.extendedAppId.appId	response.results.device.idReport.device.idReport.extendedAppId.appId	1001
idReport.extendedAppId.deviceType.name	response.results.device.idReport.device.deviceType.name	LMU
idReport.extendedAppId.extensionPrefix	response.results.device.idReport.device.idReport.extendedAppId.extensionPrefix	AID
idReport.parsedExtensions.CELL_RADIO.idReport	response.results.device.idReport.device.idReport.standardExtensions.CELL_RADIO.rawIdReport	14,53,354045090483097,0,02.002/01.000.02
idReport.parsedExtensions.CELL_RADIO.extension	response.results.device.idReport.device.idReport.standardExtensions.CELL_RADIO.extensionPrefix	RADFW
idReport.parsedExtensions.CELL_RADIO.deviceType.name	response.results.device.idReport.device.idReport.standardExtensions.CELL_RADIO.deviceType.name	CELL_RADIO
idReport.parsedExtensions.CELL_RADIO.platform	response.results.device.idReport.device.idReport.standardExtensions.CELL_RADIO.platform	62
idReport.parsedExtensions.CELL_RADIO.identifier	response.results.device.idReport.device.idReport.standardExtensions.CELL_RADIO.identifier	55286081406395
idReport.parsedExtensions.CELL_RADIO.extensionPrefix	response.results.device.idReport.device.idReport.standardExtensions.CELL_RADIO.extensionPrefix	RADFW
idReport.peripherals	response.results.device.idReport.device.peripheralToHosts
idReport.supportedMacAlgorithm.supportedMacAlgorithm	idReport.supportedMacAlgorithm.supportedMacAlgorithm	1
idReport.supportedMacAlgorithm.extensionPrefix	response.results.device.idReport.device.idReport.macAlgorithm.extensionPrefix	MAC
idReport.otaCapability.protocolMap	response.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.name	response.results.device.idReport.device.idReport.otaStatus.deviceType.name	LMU
idReport.otaStatus.fileType.CustomerConfig	response.results.device.idReport.device.idReport.otaStatus.fileType.name	Firmware
idReport.otaStatus.statCode	response.results.device.idReport.device.idReport.otaStatus.statCode	0
idReport.otaStatus.diagCode	response.results.device.idReport.device.idReport.otaStatus.diagCode	0
idReport.otaStatus.diagString	response.results.device.idReport.device.idReport.otaStatus.diagString
idReport.version.version	response.results.device.idReport.device.idReport.firmwareVersion	85f
idReport.mobileId.mobileId	response.results.device.idReport.mobileIdType.id	4572103175
idReport.mobileIdType	response.results.device.idReport.mobileIdType.description	ESN
idReport.esn	response.results.device.idReport.device.idReport.esn	4572103175
idReport.min	response.results.device.idReport.device.idReport.min
idReport.appid._id	response.results.device.idReport.device.idReport.appId.extendedAppId.appId	436
idReport.appid.id	response.results.device.idReport.device.idReport.appId	436
idReport.configVer	response.results.device.idReport.device.idReport.configVersion	25
idReport.scriptVer	response.results.device.idReport.device.idReport.scriptVersion	35
idReport.imei	response.results.device.idReport.device.idReport.imei	355286081406395
idReport.imsi	response.results.device.idReport.device.idReport.imsi	295050900474721
idReport.iccId	response.results.device.idReport.device.idReport.iccid	89883030000048291725
idReport.queryId	response.results.device.idReport.device.idReport.queryId	0
idReport.vehicleClass	response.results.device.idReport.device.idReport.vehicleClass	0
idReport.modemSelection.id	response.results.device.idReport.device.idReport.modemSelection	62
idReport.unitstatus.bitmap	response.results.device.idReport.device.idReport.unitStatus	8
idReport.unitstatus.unitStatus1	response.results.device.idReport.device.idReport.isUnitStatus1	false
idReport.unitstatus.gpsantennaStatusOK	response.results.device.idReport.device.idReport.isGPSAntennaStatusOK	false
idReport.unitstatus.gpsreceiverTestOK	response.results.device.idReport.device.idReport.isGPSReceiverTestOK	false
idReport.unitstatus.gpstrackingOK	response.results.device.idReport.device.idReport.isGPSTrackingOK	false
idReport.gpsexceptionReported	response.results.device.idReport.device.idReport.isGPSExceptionReported	false
idReport.unitstatus.bit8Ok	response.results.device.idReport.device.idReport.isBit8Ok	false
idReport.vbusIdReport	response.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.CustomerConfig	response.results.device.idReport.device.idReport.standardExtensions.JPOD2.rawIdReport	8,3.0.0,2001A002F3237471832353537,0,V01.86.43_13f_1.4.6288,1,000
idReport.vbusIdReport.fileVersionMap.Firmware	response.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.rawReport	response.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.rawReport	response.results.device.idReport.standardExtensions.HOSTED_APP.rawIdReport	250,,21,01.02.53
idReport.haidReport.deviceType.name	response.results.device.idReport.standardExtensions.HOSTED_APP.deviceType.name	HOSTED_APP
idReport.haidReport.extensionPrefix	response.results.device.idReport.standardExtensions.HOSTED_APP.extensionPrefix	HA
idReport.vinInfoStatus	response.results.device.idReport.device.idReport.extensions.VIN-INFO.[i]	VIN-INFO:VIN=1GNKRGED2CJ343269,DEV-REGN=US,SRVR-REGN=US
idReport.deviceServices.services.typeId	response.results.device.idReport.deviceServices.services.[i].typeId	1
idReport.deviceServices.services.state	response.results.device.idReport.deviceServices.services.[i].state	1
idReport.deviceServices.services.infoList	response.results.device.idReport.deviceServices.services.[i].infoList	1.2,"WILDCARD"
idReport.deviceServices.services.infoListString	response.results.device.idReport.deviceServices.services.[i].infoList	1.2,"WILDCARD"
idReport.deviceServices.services.serviceConfigVersion	response.results.device.idReport.deviceServices.services.[i].serviceConfigVersion
idReport.imeiHex	response.results.device.idReport.device.idReport.imeiHex	001538EC8C000060ED
idReport.vin	response.results.device.idReport.vinInfoList.[i].vin	19XZE4F52LE013752
firstIdReportTime	response.results.device.idReport.firstIdReportTime	2021-10-19T22:42:45.241Z
lastIdReportTime	response.results.device.extensions.idReportTimestamp	2022-01-01T16:40:12.866Z

Map to Shipping Info API

PULS JSON Path	CTC JSON Path	CTC Sample Value
shipping.trackingNum	ShipTracking	1Z90X7Y50340566629
shipping.shippedDate	ShipDate	2020-11-17 00:00:00-08

Map to Current Device File API

PULS JSON Path	CTC JSON Path	CTC Sample Value
configGroup	.newDeviceFile.version\ PI .transactionStatus.name ice.lastUpdateTime	V01.03.01.43 SUCCESS 2021-12-21T21:29:04.127Z
vehicleBus.vbusDeviceFiles	.newDeviceFile.version\ PI .transactionStatus.name ice.lastUpdateTime	V01.03.01.43 SUCCESS 2021-12-21T21:29:04.127Z
configStatus	.transactionStatus.name	SUCCESS
firmwareStatus	.transactionStatus.name	SUCCESS
firmwareHistorys.newFirmware.appId	.newDeviceFile.platforms.PI .value	416
firmwareHistorys.newFirmware.versionNumber	.newDeviceFile.version	85c
firmwareHistorys.oldFirmware.appId	.oldDeviceFile.platforms.value	416
firmwareHistorys.oldFirmware.versionNumber	.oldDeviceFile.version	85c
firmwareHistorys.status	.commandResult.status	SUCCESS
firmwareHistorys.downloadRetryCount	.commandResult.transactionStatus.retries	1
firmwareHistorys.downloadRequestTime	.requestTime	2021-05-13T17:17:31.981Z
firmwareHistorys.lastUpdateTime	.lastUpdateTime	2021-05-13T17:27:37.165Z
lastConfigUpdateTime	.lastupdateTime	2020-12-09T17:27:04.414Z

Map to Device File History API

PULS JSON Path	CTC JSON Path	CTC Sample Value
vehicleBus.vbusFileHistories	.newDeviceFile.version\ PI .transactionStatus.name ice.lastUpdateTime	V01.03.01.43 IN_PROGRESS 2021-12-21T21:26:44.194Z

GetVBus API

Map to Smart Search API

PULS JSON Path	CTC JSON Path	CTC Sample Value
esn	response.results.device.esn	4562211953
mobileId	response.results.device.idReport.mobileId	3271025936
firstIdReportTime	response.results.device.idReport.device.peripheralToHosts.[i].devicePeripheral.firstIdReportTime	2021-12-21T16:43:29.613Z
lastIdReportTime	response.results.device.idReport.device.peripheralToHosts.[i].devicePeripheral.device.updateTime	2022-01-01T16:40:12.866Z
vbusPlatform	response.results.device.idReport.device.peripheralToHosts.[i].devicePeripheral.device.idReport.platform	2.0.0
boardId	response.results.device.idReport.device.peripheralToHosts.[i].devicePeripheral.deviceIdent	105D8FF343439414B43217330
boardSerialNumber	response.results.device.idReport.device.peripheralToHosts.[i].devicePeripheral.device.idReport.identifier	105D8FF343439414B43217330
lastError	response.results.device.idReport.device.peripheralToHosts.[i].devicePeripheral.device.idReport.rawIdReport	4,2.0.0,105D8FF343439414B43217330,V05.03.01.81,V01.03.01.43,,
lastIdReport	response.results.device.extensions.idReportTimestamp	2022-01-01T16:40:12.866Z

Map to Device File History API

PULS JSON Path	CTC JSON Path	CTC Sample Value
vbusFileHistories	.newDeviceFile.version\ PI .transactionStatus.name ice.lastUpdateTime	V01.03.01.43 IN_PROGRESS 2021-12-21T21:26:44.194Z

Map to Current Device File API

PULS JSON Path	CTC JSON Path	CTC Sample Value
vbusDeviceFiles	.newDeviceFile.version\ PI .transactionStatus.name ice.lastUpdateTime	V01.03.01.43 SUCCESS 2021-12-21T21:29:04.127Z