2.2.3.181.4 SyncKey (Sync)

The SyncKey element is a required child element of the Collection element in Sync command requests and responses that contains a value that is used by the server to mark the synchronization state of a collection.

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

string ([MS-ASDTYPE] section 2.7)

1…1 (required)

Sync command response

Collection (section 2.2.3.29.2)

None

string

1…1 (required)

A synchronization key of value 0 (zero) initializes the synchronization state on the server and causes a full synchronization of the collection. The server sends a response that includes a new synchronization key value. The client MUST store this synchronization key value until the client requires the key value for the next synchronization request for that collection. When the client uses this synchronization key value to do the next synchronization of the collection, the client sends this synchronization key value to the server in a Sync request. If the synchronization is successful, the server responds by sending all objects in the collection. The response includes a new synchronization key value that the client MUST use on the next synchronization of the collection.

The client MUST store the synchronization key as an opaque string of up to 64 characters.

The client MUST send a synchronization key value of 0 in an initial Sync request and the server sends a new synchronization key value in its response to the client. The client MUST NOT ignore the synchronization key value that is included in the initial response from the server.

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

Show: