2.2.3.84 GetChanges
The GetChanges element is an optional child element of the Collection element in Sync command requests that request the server to include in its response any pending changes to the collection that is specified by the ServerId element (section 2.2.3.166.8). If there have been changes since the last synchronization, the server response includes a Commands element (section 2.2.3.32) that contains additions, deletions, and changes.
All elements referenced in this section are defined in the AirSync namespace.
|
Command request/response |
Parent elements |
Child elements |
Data type |
Number allowed |
|---|---|---|---|---|
|
Sync command request (section 2.2.1.21) |
Collection (section 2.2.3.29.2) |
None |
boolean ([MS-ASDTYPE] section 2.1) |
0...1 (optional) |
The GetChanges element appears only in requests to the server from the client.
If the client does not want the server changes returned, the request MUST include the GetChanges element with a value of 0 (FALSE). A value of 1 (TRUE) indicates that the client wants the server changes to be returned. A value of 1 (TRUE) is assumed when the GetChanges element is empty.
When the GetChanges element is not present in the request, the behavior depends on the value of the SyncKey element, as specified in section 2.2.3.181.4. If the SyncKey element has a value of 0, then the request is handled as if the GetChanges element were set to 0 (FALSE). If the SyncKey element has a non-zero value, then the request is handled as if the GetChanges element were set to 1 (TRUE).
A Status element (section 2.2.3.177.17) value of 4 is returned if the GetChanges element is present and empty or set to 1 (TRUE) when the SyncKey element value is 0 (zero). No error is returned if the GetChanges element is absent or set to 0 (FALSE) when the SyncKey value is 0 (zero).
Protocol Versions
The following table specifies the protocol versions that support this element. The client indicates the protocol version being used by setting either the MS-ASProtocolVersion header, as specified in [MS-ASHTTP] section 2.2.1.1.2.6, or the Protocol version field, as specified in [MS-ASHTTP] section 2.2.1.1.1.1, in the request.
|
Protocol version |
Element support |
|---|---|
|
2.5 |
Yes |
|
12.0 |
Yes |
|
12.1 |
Yes |
|
14.0 |
Yes |
|
14.1 |
Yes |
|
16.0 |
Yes |
|
16.1 |
Yes |