Wiki
Clone wikiNumera.LibrisAPI / device.search
Home > API Reference Documentation > device.search
device.search
The device.search action is used to search the devices in the platform.
Input Parameters
There are no required parameters. By default, the search does not return devices in a retired state.
| Property | Required | Description |
|---|---|---|
imei | no | The ending portion or entire imei of the device. The platform will replace the last digit entered into a '0' if it is not already. |
realm | no | If you want to limit the search to a specific realm |
msisdn | no | Search using the caller id number of the device (you should clean this up before sending) |
name | no | If you want to limit the search to a specific device name |
no_collector | no | Set to true to search for devices with no event collectors (previously known as patients) |
status | no | Used to filter the device status, choose from unmanaged, active, retired, activating, deactivating, suspended, unsuccessful |
status_list | no | Used to filter the device status, send as an array of strings from unmanaged, active, retired, activating, deactivating, suspended, unsuccessful |
no_realm | no | Set to true to search for devices not assigned to a realm (super user only) |
Output
The devices will be placed into a devices[] array in the result. Each device object can have the following properties, some of the properties will only returned if the user or application has certain permissions.
| Property | Description |
|---|---|
id | device id |
imei | device imei |
name | device name is a string that can be set by the dealer or other customer and be treated as a custom identifier for the device, it has no other meaning in the platform |
status | device status |
realm | device realm |
has_key | set to true when a device has contacted the platform and received its secret key |
config_status | status related to the device reading a config update from its mailbox when initiated from the partner config dashboard |
last_classify | time of the last classify event |
last_calibration | time of the last calibration event |
msisdn | if active, the caller id of the device |
iccid | SIM id inside of the Libris unit |
network_operator | network operator (ATT_EOD,ATT_RETAIL) |
event_collector_id | formally known as patient id, represents the id that points to the current event log for the device |
Updated