Get Device Details for a Phone
Device details such as manufacturer, model, OS, status, and registered email address can be retrieved in multiple ways using an API. Search requests can be made by phone number, user ID, or label. A single user may be assigned multiple devices, in which case a list of devices could be returned for a matching user ID. Given a phone number in the request, the API returns the device details for the pairing of user and phone number. Given a label in the request, the API returns the device details for all devices assigned to that label. The details returned depend on what the device reports; different devices may return different information. This API applies only to registered devices.
Examples:
- Get the device details for the device that has a specified phone number:
https://<Ivanti EPMM>/api/v1/dm/phones/4155551212
- Get the device details for the devices that have the specified phone numbers:
https://<Ivanti EPMM>/api/v1/dm/phones/6505551212,4155551212
- Get the device details for the devices belonging to the specified user:
https://<Ivanti EPMM>/api/v1/dm/users/jdoe
- Get the device details for the devices assigned to a specific label:
https://<Ivanti EPMM>/api/v1/dm/labels/android
- Get the device details for the device having a specific Wi-Fi MAC address:
https://<Ivanti EPMM>/api/v1/dm/devices/mac/38AA3C62BFAD
1. URI: https:///api/v1/dm/phones/{phone#} | Device details of the input phone number is returned. | |
|---|---|---|
Http Method: | GET | |
Format: | xml, json | |
Request: | | |
phoneNumber | Required. This can be multiple, comma-separated phone numbers. Example: 4085551212,6505551212 | |
| | |
2. URI: https:///api/v1/dm/users/ | Device details of all devices registered to the input username will be returned. | |
Http Method: | GET | |
Format: | xml, json | |
Request: | | |
userName | Required. Device unique login user name. | |
| | |
3. URI: https:///api/v1/dm/labels/ | Device details of all devices assigned to the input labelname will be returned. | |
Http Method: | GET | |
Format: | xml, json | |
Request: | | |
labelName | Required. Unique label name. | |
| | |
4. URI: https:///api/v1/dm/devices/mac/ | Device details of the device associated with the input Wi-Fi MAC address. | |
Http Method: | GET | |
Format: | xml, json | |
Request: | | |
macAddress | Required. | |
| | |
Response Status Code: | | |
‘404 – No Data Found’ | There is no data. | |
‘200 – OK’ | Data is present and the response is returned. | |
Response: | | |
<deviceManagementWebServiceResponse> | | |
<phoneNumber>14085551212</phoneNumber> | Phone numbers from the request. Included in response in these two cases: - only one phone number was in the request. - the request specified more than one phone number, and a problem occurred so that no device details are included in the response. Note: If the request specified a user name or a label name, they are not repeated at the beginning of the response. |
|
<messages> | | |
<message>212 Device(s) returned</message> | Success is shown if the method execution is successful. A descriptive error message is shown if the method execution failed. Note: If the request specified one valid phone number, the <messages> element is empty. | |
</messages> | | |
<devices> | | |
<device id=’2’> | Device identifier. | |
<uuid>8d711cdc-e93c-49b1-88d6-222f54132445</uuid> | Unique identifier for the device. | |
<principal>jdoe</principal> | User ID for the user of the device. This corresponds to the user ID in the Admin Portal, as seen in Users & Devices | Users. | |
<blockReason>0</blockReason> | A bitmap value that lists the reasons, if any, that the device is blocked from accessing the ActiveSync server. The possible values are described in Compliance, quarantinedStatus, and blockReason values. | |
<clientId>1073741831</clientId> | For Ivanti EPMM internal use. | |
<compliance>0</compliance> | A bitmap value that lists the reasons, if any, that the device is out of compliance with its security policy. The possible values are described in Compliance, quarantinedStatus, and blockReason values. | |
<countryCode>1</countryCode> | The country code for the device. | |
<countryId>183</countryId> | Country identifier for the device. Ivanti EPMM assigns this identifier to the country. | |
<countryName>United States</countryName> | | |
<details> | Device details, which consist of key-value pairs. The set of key-value pairs vary by the make, model, and operator of the device. The set shown is only an example. For more information, see Android Details Key-Value Descriptions and iOS Details Key-Value Descriptions. If device registration is pending, then the details section is empty. | |
<entry> | | |
<key>total_ram_size</key> | | |
<value>109.74M</value> | | |
</entry> | | |
<entry> | | |
<entry> | | |
<key>device_model</key> | | |
<value>SGH-i617</value> | | |
</entry> | | |
<entry> | | |
<key>platform_name</key> | | |
<value>Windows Mobile 6.1 Standard</value> | | |
</entry> | | |
</details> | | |
<deviceCount>0</deviceCount> | Not used. Always 0. | |
<emailAddress>[email protected]</emailAddress> | The user’s email address as entered during registration. | |
<emailDomain>mydomain.com</emailDomain> | Not used at this time. | |
<employeeOwned>false</employeeOwned> | true - the employee owns the device. false - the enterprise owns the device. The value is set during registration and the administrator can change it. | |
<homeOperator>Verizon</homeOperator> | The service operator for the device when it is not roaming. | |
<languageCountryId>183</languageCountryId> | The unique identifier for the country associated with the language used on the device. For example, there would be a different ID for a Canadian French language device when compared to a device from France. Ivanti EPMM assigns this identifier to the country. | |
<languageId>1</languageId> | The unique identifier for the language used on the device. | |
<lastConnectedAt>2011-07-08T01:52:33+00:00</lastConnectedAt> | The date and time that the device last made successful contact with the Ivanti EPMM server. For iOS devices that have iOS MDM enabled, this value is the time of the last iOS MDM checkin. | |
<manufacturer>Research In Motion</manufacturer> | The device manufacturer as automatically reported by the device during registration. | |
<mdmManaged>false</mdmManaged> | Indicates that the MDM profile is enabled on the device. This field applies only to iOS devices. For other devices, the value is always false. | |
<mdmProfileUrlId></mdmProfileUrlId> | Ivanti EPMM internal ID for its iOS MDM profile information. | |
<model>8130</model> | The model of the device as automatically reported by the device during registration. | |
<name>jdoe:Android 4.4:PDA 2</name> | The concatenated name used to identify the device/user combination. | |
<notifyUser>true</notifyUser> | true indicates the user should be notified via email during registration. This does not control whether Ivanti EPMM sends an SMS message given a valid phone number, which it always does. false indicates the user should not be notified during registration. The notification consists of the principal name, platform, and phone number. | |
| | |
<operator>Verizon</operator> | Service provider for the device. The value PDA indicates no operator is associated with the device. | |
<operatorId>4195</operatorId> | Identifier of the operator for the device. Ivanti EPMM assigns this identifier to the operator. | |
<phoneNumber>4085551212</phoneNumber> | The phone number entered by the user during registration. | |
<platform>Android 4.4</platform> | String indicating the platform installed on the device. The string is specified during registration. | |
<quarantinedStatus>0</quarantinedStatus> | A bitmap value that lists the reasons, if any, that the device is quarantined. When a device is quarantined, its configurations (that is, profiles) have been removed due to violations with its security policy. The possible values are described in Compliance, quarantinedStatus, and blockReason values. | |
<regCount>0</regCount> | For Blackberry, after the Ivanti EPMM client is downloaded, the VSP sends the provisioning SMS message to the client. If the client fails to connect, then the VSP resends the message at a scheduled interval. This value indicates how many times the VSP sent the provisioning message to the client. | |
<regType>DEFAULT</regType> | This value applies only to BlackBerry devices, indicating the registration type configured on the VSP. Possible values are: DEFAULT: Register/Deploy via Ivanti EPMM BES: Register via Ivanti EPMM, Deploy via BES BESAUTO: Register/Deploy via BES 5.x. | |
registeredAt | Lists the date and time of device registration. | |
<status>ACTIVE</status> | String indicating the current status of the device with regard to registration and connection. See list of valid values above. | |
<statusCode>97</statusCode> | Numeric code defined for the status. See list of valid values above. | |
<userDisplayName>Joe Doe</userDisplayName> | The concatenation of the user’s first name and last name as defined during registration. | |
<userFirstName>Joe</userFirstName> | | |
<userLastName>Doe</userLastName> | | |
<userUUID>de398fcb-a3a4-412c-a1dd-9be8bd46e728</userUUID> | Internal user ID. | |
| | |
</device> | | |
</devices> | | |
</deviceManagementWebServiceResponse> | | |
| | |