List Mobile Devices: list_mobile_devices
Service name: list_mobile_devices |
|
URL |
https://SERVER/api/?apikey=yourAPItoken&service=list_mobile_devices &required_parameters=required_parameters [&optional_parameters=optional_parameters] |
Description |
Returns a list of mobile devices. |
Parameters |
|||||
Post Variable |
Description |
Type |
Required |
Options |
Default |
Optional. Returns a description of the service. |
boolean |
no |
true |
0 |
|
clientid |
The id of the client for which information is to be returned. |
integer |
no |
0 |
0 |
siteid |
The id of the site for which information is to be returned. |
integer |
no |
0 |
0 |
deviceid |
The id of the device for which information is to be returned. |
integer |
no |
0 |
0 |
Example Service Call =list_mobile_devices |
https://SERVER/api/?apikey=yourAPItoken&service=list_mobile_devices&clientid=CLIENTID |
Example Response |
<?xml version="1.0" ?> <result created="2014-05-22T10:03:16+01:00" host="SERVER" status="OK"> <items> <client> <id>1111</id> <name>TestClient</name> <site> <id>2222</id> <name>TestSite</name> <device> <id>3333</id> <name>TestDevice</name> <status>active</status> <os> <name>ANDROID</name> <version>4.2.1</version> <build>eng.android.13868509</build> </os> <type>SMARTPHONE</type> <date_activated>2014-04-03</date_activated> <app_version>0.2.1</app_version> <manufacturer>DeviceManufacturer</manufacturer> <model>DeviceModel</model> <serial_number>SERIALNUMBER</serial_number> <processor>ARM</processor> <ram>1022984192</ram> <internal_storage_capacity>1145593856</internal_storage_capacity> <external_storage_capacity>1145593856</external_storage_capacity> <data_roaming>false</data_roaming> <wifi_mac_address>b1:b2:b3:b4:B5:B6</wifi_mac_address> <admin_rights>false</admin_rights> <regional_settings> <language>English</language> <timezone>Europe/London</timezone> </regional_settings> <sim> <network_operator>COSMOTE</network_operator> <type>GSM</type> <iccid>123456789</iccid> <imei>123456789</imei> </sim> <current_network> <network_operator>T-Mobile UK</network_operator> <type>GSM</type> </current_network> <policy_type>COD</policy_type> <phone_number>888888</phone_number> <device_holder> <first_name>John</first_name> <last_name>Doe</last_name> <email_address>john@doe.com</email_address> </device_holder> </device> </site> </client> </items> </result> |
Field Descriptions |
|||
Field |
Type |
Can Be Empty |
Description |
client / id |
integer |
no |
Unique identifier of client |
client / name |
string |
no |
Name of client |
site / id |
integer |
no |
Unique identifier of site |
site / name |
string |
no |
Name of site |
device / id |
integer |
no |
Unique identifier of device |
device / name |
string |
no |
Name of device |
device / status |
string |
no |
Status of device (active or inactive) |
device / os / name |
string |
no * |
Operating system name of the device |
device / os / version |
string |
yes * |
Operating system version of the device |
device / os / build |
string |
yes * |
Operating system build of the device |
device / type |
string |
no * |
Type of device (SMARTPHONE or TABLET) |
device / date_activated |
date |
no * |
Device activation date |
device / app_version |
string |
yes * |
Version of MDM application installed on the device |
device / manufacturer |
string |
no * |
Device manufacturer |
device / model |
string |
no * |
Device model |
device / serial_number |
string |
yes * |
Device serial number |
device / processor |
string |
yes * |
Device processor type |
device / ram |
integer |
yes * |
Device amount of RAM memory (in bytes) |
device / internal_storage_capacity |
integer |
yes * |
Device internal storage capacity (in bytes) |
device / external_storage_capacity |
integer |
yes * |
Device external storage capacity (in bytes) |
device / data_roaming |
string |
yes * |
Data roaming enabled on device (true of false) |
device / wifi_mac_address |
string |
yes * |
Device Wifi Mac Address |
device / admin_rights |
string |
yes * |
Administrator rights enabled on device (true of false) |
device / regional_settings / language |
string |
yes * |
Device language |
device / regional_settings / timezone |
string |
yes * |
Device timezone |
device / sim / network_operator |
string |
yes * |
SIM network operator name |
device / sim / type |
string |
yes * |
SIM network operator type (GSM or CDMA) |
device / sim / iccid |
integer |
yes * |
SIM ICCID |
device / sim / imei |
integer |
yes * |
SIM IMEI |
device / current_network / network_operator |
integer |
yes * |
Current network operator name |
device / current_network / type |
integer |
yes * |
Current network operator type (GSM or CMDA) |
device / policy_type |
string |
no |
Device policy type (COD or BYOD) |
device / phone_number |
string |
yes |
Device phone number |
device / device_holder / first_name |
string |
yes |
Device holder first name |
device / device_holder / last_name |
string |
yes |
Device holder last name |
device / device_holder / email |
string |
no |
Device holder email |
* field is not returned for devices that are inactive |
Example Associated Service Calls | ||
Parameter | Call | URL Format |
DeviceID | list_devices_at_client |
https://SERVER/api/?apikey=yourAPItoken&service=list_devices_at_client&clientid=CLIENTID&devicetype=server |
list_servers |
https://SERVER/api/?apikey=yourAPItoken&service=list_servers&siteid=SITEID |
|
list_workstations |
https://SERVER/api/?apikey=yourAPItoken&service=list_workstations&siteid=SITEID |
|
SiteID | list_sites | https://SERVER/api/?apikey=yourAPItoken&service=list_sites&clientid=CLIENTID |
ClientID | list_clients | https://SERVER/api/?apikey=yourAPItoken&service=list_clients |