2.2.2.46 UID
The UID element is an optional element that specifies an ID that uniquely identifies a single event or recurring series. It is defined as an element in the Calendar namespace and is used in command requests and responses as specified in section 2.2.2.
The UID element is a string data type, as specified in [MS-ASDTYPE] section 2.7. The maximum length of the string is 300 characters.
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, top-level |
Element support, child of Exception |
---|---|---|
2.5 |
Yes |
Yes |
12.0 |
Yes |
|
12.1 |
Yes |
|
14.0 |
Yes |
|
14.1 |
Yes |
|
16.0 |
Yes |
|
16.1 |
Yes |
|
When protocol version 2.5 is used, the UID element is required. It is supported as a child of the Exception element (section 2.2.2.21) only when protocol version 2.5 is used.
When protocol version 2.5, 12.0, 12.1, 14.0, or 14.1 is used, the UID element is generated by the client when the calendar item is created and is included in a command request. If the UID element is not included in the command request, the server MAY<4> create a value and include it in the command response.
When protocol version 16.0 or 16.1 is used, the UID element MUST NOT be present in a command request. Clients can include the ClientUid element (section 2.2.2.13) in a command request to provide a unique, client-derived identifier for a calendar item. When a calendar item is created, the server will generate a unique identifier for the calendar item and return the identifier in the UID element of the Sync command response ([MS-ASCMD] section 2.2.1.21) for an add operation.