Sync

Sync Service APIs

Allows the sync of health campaign data for offline applications.

Upload File For Sync.

POST/sync/file/v1/_create

Body

application/json

Details of the file and RequestInfo meta data.

sync*object

Response

200400500

Sync Request created successfully.

Body

*/*

syncobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/sync/file/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sync": {}
    }),
});
const data = await response.json();

Response

200

{
  "sync": {
    "createdAt": 1663646897,
    "modifiedAt": 1663646897,
    "campaignId": "CAMP-ID",
    "tenantId": "tenantA",
    "syncId": "GUID",
    "status": "COMPLETED",
    "file": "https://fileserver-url.com/id",
    "createdBy": "guid",
    "modifiedBy": "guid"
  }
}

Sync Status Check.

POST/sync/file/status/v1/_search

Body

application/json

Sync Status Request.

sync*object

Response

200400500

Fetched Sync Status.

Body

*/*

syncobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/sync/file/status/v1/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sync": {}
    }),
});
const data = await response.json();

Response

200

{
  "sync": {
    "createdAt": 1663646897,
    "modifiedAt": 1663646897,
    "campaignId": "CAMP-ID",
    "tenantId": "tenantA",
    "syncId": "GUID",
    "status": "COMPLETED",
    "file": "https://fileserver-url.com/id",
    "createdBy": "guid",
    "modifiedBy": "guid"
  }
}

Sync Forms.

Latest Forms are fetched.

POST/sync/forms/v1/_search

Body

application/json

Details of the Forms and RequestInfo meta data.

sync*object

Response

200400500

Forms Fetched successfully.

Body

*/*

formsFormSyncResponse (array of object)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/sync/forms/v1/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sync": {}
    }),
});
const data = await response.json();

Response

200

{
  "forms": [
    {
      "campaignId": "CAMP-1",
      "tenantId": "tenantA",
      "version": 2,
      "submitButtonText": "SUBMIT_FORM",
      "nextPageRoute": "/home",
      "submitPath": "/egov-rn-service/registration/v1/_create",
      "schema": "householdDetails",
      "elements": [
        {
          "type": "dataElement",
          "name": "First Name",
          "key": "firstName",
          "dataType": "text",
          "uiElementType": "text",
          "value": "null",
          "hint": "Enter First name",
          "validations": [
            {
              "name": "max",
              "attribute": 20
            }
          ]
        }
      ]
    }
  ]
}