Exchange 2007 Mobility Provider::GetActiveSyncDeviceStatistics

  • Article

This procedure retrieves a list of devices that are configured to synchronize with a specified user's mailbox and returns a list of statistics about the devices.

Arguments

Input argument Required Description

<identity>

No

If the Mailbox parameter is specified, the Identity parameter is disabled.

<mailbox>

No

The user's mailbox for which you want to retrieve the mobile device statistics.

<showRecoveryPassword>

No

If true, the recovery password for the device is returned as one of the displayed statistics.
Output argument Description

devices

The list of devices and corresponding statistics.

devices/ device

Statistics of a specific device.

devices/ device/ deviceIMEI

The International Mobile Equipment Identity (IMEI) of the device.

devices/ device/ devicePhoneNumber

The phone number of the device.

devices/ device/ deviceType

The device type.

devices/ device/ deviceUserAgent

The user agent of the device.

devices/ device/ firstSyncTime

The date on which the mobile device first synchronized with the user's mailbox.

devices/ device/ lastPingHeartbeat

The length of the last heartbeat interval.

devices/ device/ lastPolicyUpdateTime

The time at which the mobile device was last successfully updated.

devices/ device/ lastSyncAttemptTime

The last time the mobile device tried to synchronize with the user's mailbox.

devices/ device/ lastSuccessSync

The last time the mobile device successfully synchronized with the user's mailbox.

devices/ device/ deviceFriendlyName

The display name of the partnership that is configured on the mobile device. After the display name is configured, the device stores this name in the user's mailbox.

devices/ device/ deviceId

The string ID of the device that is stored in the user's mailbox.

devices/ device/ deviceModel

The model of the device. This information is stored in the user's mailbox.

devices/ device/ deviceOS

The client operating system that is running on the device. The device stores this information in the user's mailbox.

devices/ device/ deviceOSLanguage

The language of the operating system on the device.

devices/ device/ deviceWipeSentTime

The time at which the last device wipe command was sent from the server.

devices/ device/ deviceWipeRequestTime

The time at which the RemoteWipe setting was enabled on the mobile device.

devices/ device/ deviceWipeAckTime

The time at which the server received the last wipe acknowledgement that was sent by the client.

devices/ device/ recoveryPassword

The recovery password for the device.

Remarks

No remarks.

Sample Code

Example XML Request

<request>  
   <data /> 
   <procedure>  
      <execute namespace="Exchange 2007 Mobility Provider" procedure="GetActiveSyncDeviceStatistics" impersonate="1" >  
         <before source="data" destination="executeData" mode="merge" /> 
         <after source="executeData" destination="data" mode="merge" /> 
      </execute> 
   </procedure> 
</request>

Example XML Response

<response>  
   <data>  
      <devices>  
         <device>   
            <firstSyncTime>11/20/2006 9:18:18 PM</firstSyncTime> 
            <lastPingHeartbeat>11/20/2006 9:18:18 PM</lastPingHeartbeat> 
            <lastPolicyUpdateTime>11/20/2006 9:18:18 PM</lastPolicyUpdateTime> 
            <lastPolicyUpdateRequestTime>11/20/2006 9:18:18 PM</lastPolicyUpdateRequestTime> 
            <lastSyncAttemptTime>11/20/2006 9:18:18 PM</lastSyncAttemptTime> 
            <lastSuccessSync>11/20/2006 9:18:18 PM</lastSuccessSync> 
            <lastSyncResponseStatus /> 
            <deviceFriendlyName /> 
            <deviceId>johnc@fabrikam.com\AirSync-PocketPC-6F24CAD599A5BF1A690246B8C68FAE8D</deviceId> 
            <deviceModel /> 
            <deviceOperatorNetwork /> 
            <deviceOSAgent /> 
            <deviceOSLanguage /> 
            <deviceWipeSentTime /> 
            <deviceWipeRequestTime /> 
            <deviceWipeAckTime /> 
            <recoveryPassword>********</recoveryPassword> 
         </device> 
      </devices> 
   </data> 
</response>

Applies To

Exchange 2007 Mobility Provider API for

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0