zimbra_wsdl 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,136 @@
1
+ zimbraSync device selfcare management
2
+ -------------------------------------
3
+
4
+ Non-admin in the 'zimbraSync' Namespace:
5
+ ----------------------------------------
6
+ <GetDeviceStatusRequest>
7
+ <GetDeviceStatusResponse>
8
+ <RemoveDeviceRequest>
9
+ <RemoveDeviceResponse>
10
+ <SuspendDeviceRequest>
11
+ <SuspendDeviceResponse>
12
+ <ResumeDeviceRequest>
13
+ <ResumeDeviceResponse>
14
+ <RemoteWipeRequest>
15
+ <RemoteWipeResponse>
16
+ <CancelPendingRemoteWipeRequest>
17
+ <CancelPendingRemoteWipeResponse>
18
+
19
+
20
+
21
+ ------------------------
22
+ <GetDeviceStatusRequest>
23
+ ------------------------
24
+
25
+ List all registered devices and their status
26
+
27
+ <GetDeviceStatusRequest xmlns="urn:zimbraSync"/>
28
+
29
+ <GetDeviceStatusResponse xmlns="urn:zimbraSync">
30
+ <device id="{device_id}" type="{device_type}" protocol="{protocol_version}" [ua="{user_agent}"]>
31
+ <provisionable>{provisionable}</provisionable>
32
+ <status>{status}</status>
33
+ <firstReqReceived>{first_req_recv}</firstReqReceived>
34
+ [<lastPolicyUpdate>{last_policy_update}</lastPolicyUpdate>]
35
+ [<remoteWipeReqTime>{remote_wipe_req}</remoteWipeReqTime>
36
+ [<removeWipeAckTime>{remote_wipe_ack}</remoteWipeAckTime>]]
37
+ [<recoveryPassword>{recover_password}</recoveryPassword>]
38
+ </device>*
39
+ </GetDeviceStatusResponse>
40
+
41
+ device_id - DeviceID
42
+ device_type - DeviceType
43
+ protocol_version - Protocol Version
44
+ user_agent - User Agent
45
+ provisionable - 0: no; 1: yes
46
+ status - 0: need provision (same as 1 if provisionable=0) 1: ok; 2: suspended; 3: remote wipe requested; 4: remote wipe complete
47
+ first_req_recv - when this device first registered with the server
48
+ last_policy_update - when policy was last updated on this device
49
+ remote_wipe_req - time (seconds since epoch) when remote wipe was initiated
50
+ remote_wipe_ack - time (seconds since epoch) when device confirmed the remote wipe
51
+
52
+
53
+ ---------------------
54
+ <RemoveDeviceRequest>
55
+ ---------------------
56
+
57
+ Remove a device from registered list. This will not cause a reset of sync data, but will cause a reset of policies on the next sync.
58
+
59
+ <RemoveDeviceRequest xmlns="urn:zimbraSync">
60
+ <device id="{device_id}" />
61
+ </RemoveDeviceRequest>
62
+
63
+ <RemoveDeviceResponse />
64
+
65
+
66
+ ----------------------
67
+ <SuspendDeviceRequest>
68
+ ----------------------
69
+
70
+ Suspend a device from further sync actions.
71
+
72
+ <SuspendDeviceRequest xmlns="urn:zimbraSync">
73
+ <device id="{device_id}" />
74
+ </SuspendDeviceRequest>
75
+
76
+ <SuspendDeviceResponse />
77
+
78
+
79
+ ---------------------
80
+ <ResumeDeviceRequest>
81
+ ---------------------
82
+
83
+ Resume sync with a device if currently suspended. This will cause a policy reset, but will not reset sync data.
84
+
85
+ <ResumeDeviceRequest xmlns="urn:zimbraSync">
86
+ <device id="{device_id}" />
87
+ </ResumeDeviceRequest>
88
+
89
+ <ResumeDeviceResponse />
90
+
91
+
92
+ -------------------
93
+ <RemoteWipeRequest>
94
+ -------------------
95
+
96
+ Request a device (e.g. a lost device) be wiped of all its data on the next sync.
97
+
98
+ <RemoteWipeRequest xmlns="urn:zimbraSync">
99
+ <device id="{device_id}" />
100
+ </RemoteWipeRequest>
101
+
102
+ <RemoteWipeResponse />
103
+
104
+
105
+ --------------------------------
106
+ <CancelPendingRemoteWipeRequest>
107
+ --------------------------------
108
+
109
+ Cancel a pending Remote Wipe request. Remote Wipe can't be canceled once the device confirms the wipe.
110
+
111
+ <CancelPendingRemoteWipeRequest xmlns="urn:zimbraSync">
112
+ <device id="{device_id}" />
113
+ </CancelPendingRemoteWipeRequest>
114
+
115
+ <CancelPendingRemoteWipeResponse />
116
+
117
+
118
+
119
+ zimbra sync specific admin SOAP messages:
120
+ -----------------------------------------
121
+ <GetDevicesCountRequest>
122
+ <GetDevicesCountResponse>
123
+
124
+
125
+ ------------------------
126
+ <GetDevicesCountRequest>
127
+ ------------------------
128
+
129
+ Get the registered devices count on the server.
130
+
131
+ <GetDevicesCountRequest xmlns="urn:zimbraAdmin"/>
132
+
133
+ <GetDevicesCountResponse>
134
+ <count>1023</count>
135
+ </GetDevicesCountResponse>
136
+