1.3 Overview

The Enterprise Client Synchronization Protocol is used to access REST-based file sync services over web-based transport.

The protocol is used for uploading and downloading file data between a client and server participating in the synchronization of a namespace. Both the upload and download scenarios are driven by the client role of this protocol.

Before creating any sessions for the data transfer, the client initially queries the server for information on the sync target share and the server's capabilities.

In the upload scenario, the client is notified of local changes to the file data from an underlying Sync Framework and takes the following steps:

1. Create the server session.

2. Get the server's sync knowledge.

3. Prepare the server for upload.

4. Perform data transfer (upload).

5. Commit change.

6. Delete session.

In the download scenario, the protocol provides a mechanism for the client to receive notifications about changes on the server that will need to be synchronized. When the client receives a notification for server-side changes, the client takes the following steps:

1. Create the server session.

2. Update the server on the client’s sync knowledge.

3. Get the change batch from the server.

4. Perform data transfer (download).

5. Delete session.