2.2.3.181.3 SyncKey (GetItemEstimate)
The airsync:SyncKey element is a required child element of the Collection element in GetItemEstimate command requests that represents the current state of a collection.
Elements referenced in this section are defined in the GetItemEstimate namespace, except where otherwise indicated by the presence of a namespace prefix (as defined in section 2.2.4).
|
Command request/response |
Parent elements |
Child elements |
Data type |
Number allowed |
|---|---|---|---|---|
|
GetItemEstimate command request (section 2.2.1.9) |
Collection (section 2.2.3.29.1) |
None |
string ([MS-ASDTYPE] section 2.7) |
1…1 (required) |
The value of the element is examined by the server to determine the state of the synchronization process. The airsync:SyncKey element is the first child element of the Collection element (section 2.2.3.29.1) in a GetItemEstimate command request.
The airsync:SyncKey element value used within the GetItemEstimate requests is the same as the one returned within the Sync responses. The server does not update the airsync:SyncKey value on GetItemEstimate requests. For more details about the airsync:SyncKey element, see section 2.2.3.181.4. The server checks the value of the key to verify that the value of the airsync:SyncKey element provided in the request matches a airsync:SyncKey value on the server. The server MUST provide a Status element (section 2.2.3.177.7) value of 4 if the airsync:SyncKey value provided in the GetItemEstimate request does not match those expected within the next Sync command request (section 2.2.1.21).
The airsync:SyncKey element value is a string value up to 64 characters in length.
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 |
When the protocol version 2.5, 12.0, or 12.1 is used, the airsync:SyncKey element is placed after the FilterType element in a GetItemEstimate command request.