Supervision

Supervision Service APIs

This facilitates the supervision of campaigns.

Submit a Checklist.

post

Submits a checklist Ok response is returned.

Body

The request object, containing all necessary information for creating an submission and the request body metadata

Responses

200

Checklist Request created successfully.

application/json

400

Bad request

application/json

500

Internal server error

application/json

post

HTTPcURLJavaScriptPython

POST /supervision/checklist/submission/v1/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 492

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "submission": {
    "tenantId": "tenantA",
    "campaignId": "ID-1",
    "boundaryId": "Boundary-Id",
    "administrativeUnit": "SOLIMBO",
    "performedAt": 1663218161,
    "schemaId": "CHECKLIST_NAME",
    "version": 2,
    "responses": [
      {
        "key": "height",
        "value": 180
      }
    ],
    "clientReferenceId": "GUID",
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    }
  }
}

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "submission": {
    "tenantId": "tenantA",
    "campaignId": "ID-1",
    "boundaryId": "Boundary-Id",
    "administrativeUnit": "SOLIMBO",
    "performedAt": 1663218161,
    "schemaId": "CHECKLIST_NAME",
    "version": 2,
    "responses": [
      {
        "key": "height",
        "value": 180
      }
    ],
    "clientReferenceId": "GUID",
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "submissionId": "UUID"
  }
}

Search Checklist.

post

Search Checklist Ok response is returned.

Body

Responses

200

Fetched Search Checklist.

application/json

400

Bad request

application/json

500

Internal server error

application/json

post

HTTPcURLJavaScriptPython

POST /supervision/checklist/v1/_search HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 322

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "submissionSearchCriteria": {
    "campaignId": "UUID",
    "submissionId": "ID",
    "submittedAt": 1663218161,
    "clientReferenceId": "GUID",
    "administrativeUnit": "SOLIMBO",
    "limit": 0,
    "offset": 0
  }
}

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "totalCount": 0,
  "submissions": [
    {
      "tenantId": "tenantA",
      "campaignId": "ID-1",
      "boundaryId": "Boundary-Id",
      "administrativeUnit": "SOLIMBO",
      "performedAt": 1663218161,
      "schemaId": "CHECKLIST_NAME",
      "version": 2,
      "responses": [
        {
          "key": "height",
          "value": 180
        }
      ],
      "clientReferenceId": "GUID",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "submissionId": "UUID"
    }
  ]
}