3.4.5.1.1 PUT

This operation is transported by an HTTP PUT request.

The operation can be invoked through the following URI suffix:

 Sync/{version}/Session

The following is an example of a complete URI for this operation:

https://contoso.com/Sync/1.0/Session

The request message for this operation contains the following HTTP headers.

Request header

Usage

Value

x-ecs-partnershipID

Required

The PartnershipId for the sync target.

x-ecs-devicename

Optional

A string as specified in section 2.2.1.2.

The response message for this operation contains the following HTTP headers.

Response header

Usage

Value

x-ecs-request-error

Optional

A string describing request failure information. This MUST be a string representation of the HRESULT in hexadecimal format.

Example:

x-ecs-request-error: "0x8007005"

x-ecs-admin-contact

Optional

A string representing the email contact of the server administrator.

x-ecs-metadata-version

A string containing the version of the server metadata for the current sync replica.

x-ecs-session-id

Optional

A GUID in string format or an implementation-specific string that identifies the session. The client MUST use this value to build the complete URL in the subsequent requests on a session.

The response message for this operation can result in the following status codes.

Status code

Description

200

The response contains the URI prefix for a session that already exists.

201

The response contains the URI prefix for a newly created session.

400

Invalid session type.