Last updated 1 year ago
Was this helpful?
Allows the sync of health campaign data for offline applications.
The request object, containing all necessary information for file sync and the request body metadata
RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.
The request object, containing all necessary information for creating an submission and the request body metadata
POST /sync/file/v1/_create HTTP/1.1 Host: Content-Type: application/json Accept: */* Content-Length: 259 { "requestInfo": { "apiId": "text", "ver": "text", "ts": 1, "action": "text", "did": "text", "key": "text", "msgId": "text", "requesterId": "text", "authToken": "text" }, "sync": { "campaignId": "CAMP-ID", "tenantId": "tenantA", "file": "https://fileserver-url.com/id", "auditDetails": {} } }
Sync Request created successfully.
{ "responseInfo": { "apiId": "text", "ver": "text", "ts": 1, "resMsgId": "text", "msgId": "text", "status": "SUCCESSFUL" }, "sync": { "createdAt": 1663646897, "modifiedAt": 1663646897, "campaignId": "CAMP-ID", "tenantId": "tenantA", "syncId": "GUID", "status": "COMPLETED", "file": "https://fileserver-url.com/id", "createdBy": "guid", "modifiedBy": "guid" } }
POST /sync/file/status/v1/_search HTTP/1.1 Host: Content-Type: application/json Accept: */* Content-Length: 218 { "requestInfo": { "apiId": "text", "ver": "text", "ts": 1, "action": "text", "did": "text", "key": "text", "msgId": "text", "requesterId": "text", "authToken": "text" }, "sync": { "campaignId": "CAMP-ID", "tenantId": "tenantA", "syncId": "GUID" } }
Fetched Sync Status.
Latest Forms are fetched.
The request object, containing all necessary information for form sync and the request body metadata
POST /sync/forms/v1/_search HTTP/1.1 Host: Content-Type: application/json Accept: */* Content-Length: 273 { "requestInfo": { "apiId": "text", "ver": "text", "ts": 1, "action": "text", "did": "text", "key": "text", "msgId": "text", "requesterId": "text", "authToken": "text" }, "sync": { "campaignId": "CAMP-ID", "tenantId": "tenantA", "syncAll": true, "forms": [ { "schemaId": "householdDetails", "version": "1" } ] } }
Forms Fetched successfully.
{ "responseInfo": { "apiId": "text", "ver": "text", "ts": 1, "resMsgId": "text", "msgId": "text", "status": "SUCCESSFUL" }, "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 } ] } ] } ] }
