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.

POSThttps://staging.open-sunbird.org/api/data/v1/index/sync

Header parameters

Body

application/json

The body refers to the format of the request.

• The body contains metadata about synchronization of data.

params*object

request*Request

Response

200400500

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

Body

application/json

resultNode Id

idstring

API Identifier

verstring

API version information

tsstring

API execution timespan

paramsResponse Parameter

responseCodeobject

API response code

Request

JavaScriptCurl

const response = await fetch('https://staging.open-sunbird.org/api/data/v1/index/sync', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "params": {},
      "request": {
        "objectType": "text"
      }
    }),
});
const data = await response.json();

Response

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