Data Sync

Data synchronization API(s) establish consistency among data from a source to a target data storage.

Syncs data

This API is associated with synchnorization of data on the Sunbird Platform.

• The endpoint for Syncs data is /sync
• The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

post

/data/v1/index/sync

Header parameters

Content-Typestringrequired

The Content Type entity is the media type of the resource.Possible media types can be:-

• Application/json
• Multipart/form-data
• Application/x-www-form-urlencoded

tsstringrequired

Time Stamp at which data sync request was sent.

X-msgidstringrequired

This Id Uniquely identifies a request if the same API is executed multiple times.

X-Device-IDstringrequired

This Id Uniquely identifies the type of device (Mobile)(desktop) used to access Sunbird. 'The Registered User ID to execute the API.

Authorizationstringrequired

All content APIs require authorization for use. Specify the authorization key received from the administrator when placing the request for use of the API.

Body

requestRequestrequired

paramsobjectrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://staging.open-sunbird.org/api/data/v1/index/sync' \
  --header 'Content-Type: application/json' \
  --header 'ts: text' \
  --header 'X-msgid: text' \
  --header 'X-Device-ID: text' \
  --header 'Authorization: text' \
  --data '{"request":{"objectType":"text","objectIds":[null]},"params":{}}'

200

400

500

200

{
  "result": {
    "node_id": "text"
  },
  "id": "text",
  "ver": "text",
  "ts": "text",
  "params": {
    "resmsgid": "text",
    "msgid": "text",
    "err": "text",
    "status": "text",
    "errmsg": "text"
  },
  "responseCode": {}
}

OK ! Successful operation."Data sync" operation was successfully executed.