2.2.3.28.2 ClientId (Sync)
The ClientId element is a required child element of the Add element in Sync command requests and responses that contains a unique identifier (typically an integer) that is generated by the client to temporarily identify a new object that is being created by using the Add element. The client includes the ClientId element in the Add element request that it sends to the server. The server response contains an Add element that contains the original client ID and a new server ID that was assigned for the object, which replaces the client ID as the permanent object identifier.
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) |
Add (section 2.2.3.7.2) |
None |
string ([MS-ASDTYPE] section 2.7) |
1…1 (required) |
|
Sync command response |
Add (section 2.2.3.7.2) |
None |
string |
1…1 (required) |
The ClientId element is a unique identifier that consists of up to 64 digits and letters. The client generates this ID. The value only has to be unique for the device during the duration of the Sync request that adds the object to the server. The client stores the client IDs until the synchronization session is completed successfully, to make recovery easier if the synchronization process fails.
An easy way to implement the client ID is to use a counter that is incremented for each new object that is created on the client.
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 |