API Call Examples
Login
Call Setting
| Field | Content |
|---|---|
| POST | https://connect.calamp.com/connect/services/login |
| Header | Content-Type: application/x-www-form-urlencoded |
| Body | x-www-form-urlencoded username: password: useAuthToken: true |
Examples
Smart Search
Call Setting
| Field | Content |
|---|---|
| POST | 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 |
| Header | calamp-services-app: |
| Body | raw: JSON |
Example Search Bodies
| Example | Search 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
Searchable Properties
| Property Name | Type | Comments |
|---|---|---|
| account | long[] | |
| extensions.firmwareVersion | string[] | |
| extensions.networkMode | string[] | |
| pegBehaviorId | long[] | |
| mdn | string[] | Searchable without the property name |
| ipAddress | string[] | Searchable without the property name |
| activationDate | date[] | yyyy-MM-dd'T'HH:mm:ss.SSSZ |
| name | string[] | Searchable without the property name |
| deviceConfigurationId | long[] | |
| lastModifiedOn | dat | yyyy-MM-dd'T'HH:mm:ss.SSSZ |
| provisionStatus | string[] | |
| status | resourceStatus[] | |
| serialNumber | string[] | Searchable without the property name |
| extensions.vbusEnableStatus | string[] | |
| extensions.poNumber | string[] | |
| category | devicecategory[] | |
| createdOn | date[] | yyyy-MM-dd'T'HH:mm:ss.SSSZ |
| architecture | devicearchitecture[] | |
| extensions.shippingOrder | string[] | |
| extensions.networkCarrier | string[] | |
| esn | string[] | Searchable without the property name |
| iccid | string[] | Searchable without the property name |
| typeid | long[] | |
| airId | string[] | Searchable without the property name |
| groupIds | list[] | |
| dmDevice | boolean[] | |
| extensions.signalStrength | string[] | |
| lastReportedTime | date[] | yyyy-MM-dd'T'HH:mm:ss.SSSZ |
| accountId | long[] | |
| imei | string[] | Searchable without the property name |
| extensions.configVersion | string[] | |
| id | long[] | Searchable without the property name |
| extensions.sku | string[] | |
| externalId | string[] | Searchable without the property name |
| macAddress | string[] | Searchable without the property name |
| shipDate | date[] | yyy-MM-dd'T'HH:mm:ss.SSSZ |
| typeName | string[] | |
| meid | string[] | Searchable without the property name |
| type | long[] | |
| extensions.idReportTimestamp | date[] | yyy-MM-dd'T'HH:mm:ss.SSSZ |
| extensions.networkCurrentMode | string[] | |
| extensions.fileVersion | string[] | |
| extensions.appId | string[] | |
| min | long[] | Searchable without the property name |
| imsi | string[] | Searchable without the property name |
| phoneNumber | string[] | Searchable without the property name |
Shipping Information
Call Setting
| Field | Content |
|---|---|
| GET | https://connect.calamp.com/device-services/devices/{esn}/shippinginfo |
| Headers | calamp-services-app: |
Examples
Current Device File
Call Setting
| Field | Content |
|---|---|
| GET | https://connect.calamp.com/device-services/devices/{esn}/filehistory/current |
| Headers | calamp-services-app: |
Examples
Device File History
Call Setting
| Field | Content |
|---|---|
| GET | https://connect.calamp.com/device-services/devices/{esn}/filehistory |
| Headers | calamp-services-app: |
Examples
Additional Resources
Updated about 1 year ago
What’s Next