API Call Examples

Login

Call Setting

FieldContent
POSThttps://connect.calamp.com/connect/services/login
HeaderContent-Type: application/x-www-form-urlencoded
Bodyx-www-form-urlencoded
username: <user>
password: <pass>
useAuthToken: true

Examples

1560 1422

Smart Search

Call Setting

Example Search Bodies

ExampleSearch Body
Search for a specific ESN.{ "search": {"queryString": "4562211953"}}
Request all the devices in an account and its subaccounts.{ "search": {
"queryString": "*",
"accountId": 1110,
"hierLevel": "All"
}}
Request multiple devices.{ "search": {
"queryString": "esn: (4562211953 OR 1110000305 OR 3671000349)"
}}
Request all the devices in group 4650.{ "search": {
"queryString": "groupIds: (4650)",
"accountId": 1110,
"hierLevel": "All"
}}
Request all the devices with a name containing "demo."{ "search": {
"queryString": "name: (demo)",
"accountId": 1110,
"hierLevel": "All"
}}
Request all the devices with firmware 8.4a or 8.6c.{ "search": {
"queryString": "extensions.firmwareVersion: (84a OR 86c)",
"accountId": 1110,
"hierLevel": "All"
}}

Examples

1421 1422 1416

Searchable Properties

Property NameTypeComments
accountlong[]
extensions.firmwareVersionstring[]
extensions.networkModestring[]
pegBehaviorIdlong[]
mdnstring[]Searchable without the property name
ipAddressstring[]Searchable without the property name
activationDatedate[]yyyy-MM-dd'T'HH:mm:ss.SSSZ
namestring[]Searchable without the property name
deviceConfigurationIdlong[]
lastModifiedOndatyyyy-MM-dd'T'HH:mm:ss.SSSZ
provisionStatusstring[]
statusresourceStatus[]
serialNumberstring[]Searchable without the property name
extensions.vbusEnableStatusstring[]
extensions.poNumberstring[]
categorydevicecategory[]
createdOndate[]yyyy-MM-dd'T'HH:mm:ss.SSSZ
architecturedevicearchitecture[]
extensions.shippingOrderstring[]
extensions.networkCarrierstring[]
esnstring[]Searchable without the property name
iccidstring[]Searchable without the property name
typeidlong[]
airIdstring[]Searchable without the property name
groupIdslist[]
dmDeviceboolean[]
extensions.signalStrengthstring[]
lastReportedTimedate[]yyyy-MM-dd'T'HH:mm:ss.SSSZ
accountIdlong[]
imeistring[]Searchable without the property name
extensions.configVersionstring[]
idlong[]Searchable without the property name
extensions.skustring[]
externalIdstring[]Searchable without the property name
macAddressstring[]Searchable without the property name
shipDatedate[]yyy-MM-dd'T'HH:mm:ss.SSSZ
typeNamestring[]
meidstring[]Searchable without the property name
typelong[]
extensions.idReportTimestampdate[]yyy-MM-dd'T'HH:mm:ss.SSSZ
extensions.networkCurrentModestring[]
extensions.fileVersionstring[]
extensions.appIdstring[]
minlong[]Searchable without the property name
imsistring[]Searchable without the property name
phoneNumberstring[]Searchable without the property name

Shipping Information

Call Setting

FieldContent
GET https://connect.calamp.com/device-services/devices/{esn}/shippinginfo
Headerscalamp-services-app: <yourAPIkey>

Examples

1425

Current Device File

Call Setting

FieldContent
GEThttps://connect.calamp.com/device-services/devices/{esn}/filehistory/current
Headerscalamp-services-app: <yourAPIkey>

Examples

1418

Device File History

Call Setting

FieldContent
GEThttps://connect.calamp.com/device-services/devices/{esn}/filehistory
Headerscalamp-services-app: <yourAPIkey>

Examples

1433

Additional Resources


What’s Next