Service: zimbraSync
Namespace: "urn:zimbraSync"
RemoteWipe SOAP Command

Request a device (e.g. a lost device) be wiped of all its data on the next sync.

Network edition only API TRUE
Authorization token required true
Admin Authorization token required false

RemoteWipeRequest

    <RemoteWipeRequest> ## RemoteWipeRequest
        <device id="{device-id}" /> ## DeviceId
    </RemoteWipeRequest>

The following table describes elements and attributes you can define within a <RemoteWipeRequest> element:

XPath Required / Optional Description
/device Required (only 1) Specify the device to wipe
/device@id Required (only 1) Type:String
device ID

RemoteWipeResponse

    <RemoteWipeResponse> ## RemoteWipeResponse
        <device id="{device-id}" type="{device-type}" [ua="{user-agent}"] [protocol="{protocol-version}"]
                    [model="{device-model}"] [imei="{imei}"] [friendly_name="{friendly-name}"] [os="{os}"]
                    [os_language="{os-language}"] [phone_number="{phone-number}"]> ## DeviceStatusInfo
            <provisionable /> ## 0|1
            <status>{status} (Byte)</status>
            <firstReqReceived>{firstReqReceived} (Integer)</firstReqReceived>
            <lastPolicyUpdate>{lastPolicyUpdate} (Integer)</lastPolicyUpdate>
            <remoteWipeReqTime>{remoteWipeReqTime} (Integer)</remoteWipeReqTime>
            <remoteWipeAckTime>{remoteWipeAckTime} (Integer)</remoteWipeAckTime>
            <recoveryPassword>{recoveryPassword} (String)</recoveryPassword>
            <lastUsedDate>{lastUsedDate} (String)</lastUsedDate>
         </device>
    </RemoteWipeResponse>

The following table describes elements and attributes you can define within a <RemoteWipeResponse> element:

XPath Required / Optional Description
/device Optional (0 or 1) Device status information
/device@id Required (only 1) Type:String
device ID
/device@type Required (only 1) Type:String
Device type
/device@ua Optional (0 or 1) Type:String
User agent
/device@protocol Optional (0 or 1) Type:String
Protocol version
/device@model Optional (0 or 1) Type:String
Device model
/device@imei Optional (0 or 1) Type:String
IMEI (International Mobile Equipment Identity)
/device@friendly_name Optional (0 or 1) Type:String
Friendly name of the device
/device@os Optional (0 or 1) Type:String
Device running OS (Operating System; e.g. android, ios etc.)
/device@os_language Optional (0 or 1) Type:String
OS language
/device@phone_number Optional (0 or 1) Type:String
Phone number
/device/provisionable Required (only 1) Flag whether device is provisionable or not.
/device/status Required (only 1) Type:{status} (Byte)
Device status
0 need provision (same as 1 if provisionable=0)
1 ok
2 suspended
3 remote wipe requested
4 remote wipe complete
/device/firstReqReceived Required (only 1) Type:{firstReqReceived} (Integer)
When this device first registered with the server
/device/lastPolicyUpdate Optional (0 or 1) Type:{lastPolicyUpdate} (Integer)
When policy was last updated on this device
/device/remoteWipeReqTime Optional (0 or 1) Type:{remoteWipeReqTime} (Integer)
Time (seconds since epoch) when remote wipe was initiated
/device/remoteWipeAckTime Optional (0 or 1) Type:{remoteWipeAckTime} (Integer)
Time (seconds since epoch) when device confirmed the remote wipe
/device/recoveryPassword Optional (0 or 1) Type:{recoveryPassword} (String)
Recovery password
/device/lastUsedDate Optional (0 or 1) Type:{lastUsedDate} (String)
Date when the device was last used (the date is stored in server's time zone)