2.2.3.166.8 ServerId (Sync)

The ServerId element is a required child element of the Change element, the Delete element, and the Fetch element in Sync command requests. It is an optional child element of the Add element, the Change element, the Delete element, and the Fetch element under the Responses element (section 2.2.3.154) in Sync command responses. It is a required child element of the Add element, the Change element, the Delete element, the Fetch element, and the SoftDelete element under the Commands element (section 2.2.3.32) in Sync command responses. It represents a unique identifier that is assigned by the server to each object that can be synchronized. When using protocol version 16.1, a given item MUST have the same ServerId value after a resynchronization or when retrieved by a different client. The client MUST store the server ID for each object as an opaque string of up to 64 characters and MUST be able to locate an object given a server ID.

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)

Change (section 2.2.3.24)

Delete (section 2.2.3.42.2)

Fetch (section 2.2.3.67.2)

None

string ([MS-ASDTYPE] section 2.7)

1…1 (required)

Sync command response

Add (as a child of Commands) (section 2.2.3.7)

Change (as a child of Commands)

Fetch (as a child of Commands)

Delete (as a child of Commands)(

SoftDelete (as a child of Commands) (section 2.2.3.172)

None

string

1…1 (required)

Sync command response

Add (as a child of Responses)

Change (as a child of Responses)

Delete (as a child of Responses)

Fetch (as a child of Responses)

None

string

0…1 (optional)

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