3.4.5.2.1 GET

The GET method on the Sync Batch Parameters resource is issued by the client to obtain the server's sync knowledge in an upload scenario.

This operation is transported by an HTTP GET request.

The operation can be invoked through the following URI suffix using Session.SessionId:

 /SyncBatchParameters

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

https://contoso.com/Sync/1.0/Session/{60b8ca1d-59f3-4495-b299-f6cad89ada3b}/SyncBatchParameters

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 share returned by the server in the GET response on Share Discovery resource.

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"

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

Status code

Description

200

Batch parameters are returned in the response body.

404

No session exists with the specified ID.