Get Devices By Status
A device within the Ivanti EPMM system travels through a variety of different states, each of which can be retrieved through an API call. States such as enrollment-in-progress, active, retired, lost, or wiped can be retrieved. This API returns all devices that match the requested status type. If the status is not specified, all devices with ‘Active’ status are returned.
Examples:
Get all devices with the status ACTIVE:
https://<Ivanti EPMM>/api/v1/dm/devices
Get all devices with the status LOST:
https://<Ivanti EPMM>/api/v1/dm/devices?status=LOST
URI: https:///api/v1/dm/devices | Devices with the input status are returned. |
|---|---|
Http Method: | GET |
Format: | xml, json |
Request: | |
Status | Optional. See list of valid values above. |
Response Status Code: | |
‘404 – No Data Found’ | There is no data. |
‘200 – OK’ | Data is present and the response is returned. |
Response: | |
<deviceManagementWebServiceResponse> | |
<messages> | |
<message>212 Device(s) returned</message> | Status message. |
</messages> | |
<devices> | |
<device id='2’> | |
<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 Ivanti EPMM 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. |
<comment>comment for the device</comment> | Comment entered by the administrator. |
<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> | 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> | Country name for the device. |
<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>device_model</key> | |
<value>DROIDX</value> | |
</entry> | |
<entry> | |
<key>platform_name</key> | |
<value>2.2</value> | |
</entry> | |
<entry> | |
<key>Client_version</key> | |
<value>4.2.0</value> | |
</entry> | |
</details> | |
<deviceCount>1</deviceCount> | Not used. Always 0. |
<easLastSyncAttempt>2012-01-10T20:36:57+00:00</easLastSyncAttempt> | Time of the last attempt the device made to synchronize with Exchange ActiveSync. |
<easUuid>4d22d6d7-29dc-4c35-8e67-23dee442cf85</easUuid> | Exchange ActiveSync device id. |
<emailAddress>[email protected]</emailAddress> | The user’s email address as entered during registration. |
<emailDomain>txt.att.net</emailDomain> | Email domain of the operator for the device. |
<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>0<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 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. The notification consists of the principal name, platform, and phone number. |
<operator>AT&T</operator> | Service provider for the device. The value PDA indicates no operator is associated with the device. |
<operatorId>269</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 or administrator during registration. |
<pin>2732E6DB</pin> | Unique identification number for a BlackBerry device. Not available for other devices. |
<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 Ivanti EPMM. Possible values are: DEFAULT: Register/Deploy via Ivanti EPMM BES: Register via Ivanti EPMM, Deploy via BES BESAUTO: Register/Deploy via BES 5.x |
<status>ACTIVE</status> | String indicating the current status of the device with regard to registration and connection. For valid values, see Status field 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> | |
<userSource>76</userSource> | Value 76 for a Local user. Value 68 for an LDAP user. Note: 76 is the value of ASCII ‘L’, which stands for Local. 68 is the value of ASCII ‘D’, which stands for Directory (LDAP). |
<userUUID>de398fcb-a3a4-412c-a1dd-9be8bd46e728</userUUID> | Internal user ID. |
<iPhoneVersion>8J2</iPhoneVersion> | Version number of iPhone. |
</device> | |
</devices> | |
</deviceManagementWebServiceResponse> | |
| |