Registration

Campaign Registration Service APIs

Facilitates the registration of households to campaigns.

Register a Household to a Campaign.

Registers a Household. On successful Household Registered, Ok response is returned.

post

/household/v1/_create

Body

requestInfoobject

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.

householdRegistrationobjectrequired

A representation of Household.

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/registration/household/v1/_create' \
  --header 'Content-Type: application/json'

200

400

500

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "householdRegistration": {
    "householdRegistrationId": "H-ID-1",
    "tenantId": "tenantA",
    "campaignId": "CAMP-001",
    "clientReferenceId": "GUID",
    "noOfIndividuals": 4,
    "address": "Address XYZ",
    "dateOfRegistration": 1663218161,
    "location": {
      "latitude": 18.22,
      "longitude": 71,
      "accuracy": 9
    },
    "administrativeUnit": "SOLIMBO",
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "individuals": [
      {
        "name": "text",
        "dateOfBirth": "YYYYMMDD",
        "registrationId": "R-ID-1",
        "isHead": true,
        "additionalFields": {
          "schema": "HOUSEHOLD",
          "version": 2,
          "fields": [
            {
              "key": "height",
              "value": 180
            }
          ]
        },
        "gender": "MALE",
        "identifiers": [
          {
            "type": "SYSTEM_GENERATED",
            "identifierId": "ABCD-1212"
          }
        ]
      }
    ]
  }
}

Household created successfully.

Update A Household Campaign Registration.

Update A Household, Ok response is returned.

post

/household/v1/_update

Body

requestInfoobject

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.

householdRegistrationobjectrequired

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/registration/household/v1/_update' \
  --header 'Content-Type: application/json'

200

400

500

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "householdRegistration": {
    "householdRegistrationId": "H-ID-1",
    "tenantId": "tenantA",
    "campaignId": "CAMP-001",
    "clientReferenceId": "GUID",
    "noOfIndividuals": 4,
    "address": "Address XYZ",
    "dateOfRegistration": 1663218161,
    "location": {
      "latitude": 18.22,
      "longitude": 71,
      "accuracy": 9
    },
    "administrativeUnit": "SOLIMBO",
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "individuals": [
      {
        "name": "text",
        "dateOfBirth": "YYYYMMDD",
        "registrationId": "R-ID-1",
        "isHead": true,
        "additionalFields": {
          "schema": "HOUSEHOLD",
          "version": 2,
          "fields": [
            {
              "key": "height",
              "value": 180
            }
          ]
        },
        "gender": "MALE",
        "identifiers": [
          {
            "type": "SYSTEM_GENERATED",
            "identifierId": "ABCD-1212"
          }
        ]
      }
    ]
  }
}

Updated Household Registration successfully.

Search Household Registrations to a Campaign.

Search Household Registrations Ok response is returned.

post

/household/v1/_search

Body

requestInfoobject

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.

householdRegistrationSearchCriteriaobject

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/registration/household/v1/_search' \
  --header 'Content-Type: application/json'

200

400

500

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "totalCount": 1,
  "householdRegistration": [
    {
      "householdRegistrationId": "H-ID-1",
      "tenantId": "tenantA",
      "campaignId": "CAMP-001",
      "clientReferenceId": "GUID",
      "noOfIndividuals": 4,
      "address": "Address XYZ",
      "dateOfRegistration": 1663218161,
      "location": {
        "latitude": 18.22,
        "longitude": 71,
        "accuracy": 9
      },
      "administrativeUnit": "SOLIMBO",
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "individuals": [
        {
          "name": "text",
          "dateOfBirth": "YYYYMMDD",
          "registrationId": "R-ID-1",
          "isHead": true,
          "additionalFields": {
            "schema": "HOUSEHOLD",
            "version": 2,
            "fields": [
              {
                "key": "height",
                "value": 180
              }
            ]
          },
          "gender": "MALE",
          "identifiers": [
            {
              "type": "SYSTEM_GENERATED",
              "identifierId": "ABCD-1212"
            }
          ]
        }
      ]
    }
  ]
}

Fetched Search Household.

Create a Individual Registration.

Registers a Individual. On successful Individual Registered, Ok response is returned.

post

/individual/v1/_create

Body

requestInfoobject

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.

individualRegistrationobjectrequired

A representation of Individual Registration to a Campaign.

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/registration/individual/v1/_create' \
  --header 'Content-Type: application/json'

200

400

500

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "individualRegistration": {
    "registrationId": "R-ID-1",
    "tenantId": "tenantA",
    "campaignId": "CAMP-001",
    "name": "John Doe",
    "dateOfBirth": 1663218161,
    "address": "Address XYZ",
    "dateOfRegistration": 1663218161,
    "clientReferenceId": "GUID",
    "location": {
      "latitude": 18.22,
      "longitude": 71,
      "accuracy": 9
    },
    "administrativeUnit": "SOLIMBO",
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "gender": "MALE",
    "identifiers": [
      {
        "type": "SYSTEM_GENERATED",
        "identifierId": "ABCD-1212"
      }
    ],
    "individuals": [
      {
        "name": "text",
        "dateOfBirth": "YYYYMMDD",
        "registrationId": "R-ID-1",
        "isHead": true,
        "additionalFields": {
          "schema": "HOUSEHOLD",
          "version": 2,
          "fields": [
            {
              "key": "height",
              "value": 180
            }
          ]
        },
        "gender": "MALE",
        "identifiers": [
          {
            "type": "SYSTEM_GENERATED",
            "identifierId": "ABCD-1212"
          }
        ]
      }
    ]
  }
}

Individual created successfully.

Update An Individual.

Update An Individual, Ok response is returned.

post

/individual/v1/_update

Body

requestInfoobject

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.

individualRegistrationobjectrequired

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/registration/individual/v1/_update' \
  --header 'Content-Type: application/json'

200

400

500

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "individualRegistration": {
    "registrationId": "R-ID-1",
    "tenantId": "tenantA",
    "campaignId": "CAMP-001",
    "name": "John Doe",
    "dateOfBirth": 1663218161,
    "address": "Address XYZ",
    "dateOfRegistration": 1663218161,
    "clientReferenceId": "GUID",
    "location": {
      "latitude": 18.22,
      "longitude": 71,
      "accuracy": 9
    },
    "administrativeUnit": "SOLIMBO",
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "gender": "MALE",
    "identifiers": [
      {
        "type": "SYSTEM_GENERATED",
        "identifierId": "ABCD-1212"
      }
    ],
    "individuals": [
      {
        "name": "text",
        "dateOfBirth": "YYYYMMDD",
        "registrationId": "R-ID-1",
        "isHead": true,
        "additionalFields": {
          "schema": "HOUSEHOLD",
          "version": 2,
          "fields": [
            {
              "key": "height",
              "value": 180
            }
          ]
        },
        "gender": "MALE",
        "identifiers": [
          {
            "type": "SYSTEM_GENERATED",
            "identifierId": "ABCD-1212"
          }
        ]
      }
    ]
  }
}

Updated Individual successfully.

Search Individual Registrations.

Search Individual Registrations Ok response is returned.

post

/individual/v1/_search

Body

requestInfoobject

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.

individualRegistrationSearchCriteriaobject

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/registration/individual/v1/_search' \
  --header 'Content-Type: application/json'

200

400

500

200

{
  "responseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "totalCount": 1,
  "individualRegistrations": [
    {
      "registrationId": "R-ID-1",
      "tenantId": "tenantA",
      "campaignId": "CAMP-001",
      "name": "John Doe",
      "dateOfBirth": 1663218161,
      "address": "Address XYZ",
      "dateOfRegistration": 1663218161,
      "clientReferenceId": "GUID",
      "location": {
        "latitude": 18.22,
        "longitude": 71,
        "accuracy": 9
      },
      "administrativeUnit": "SOLIMBO",
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "gender": "MALE",
      "identifiers": [
        {
          "type": "SYSTEM_GENERATED",
          "identifierId": "ABCD-1212"
        }
      ],
      "individuals": [
        {
          "name": "text",
          "dateOfBirth": "YYYYMMDD",
          "registrationId": "R-ID-1",
          "isHead": true,
          "additionalFields": {
            "schema": "HOUSEHOLD",
            "version": 2,
            "fields": [
              {
                "key": "height",
                "value": 180
              }
            ]
          },
          "gender": "MALE",
          "identifiers": [
            {
              "type": "SYSTEM_GENERATED",
              "identifierId": "ABCD-1212"
            }
          ]
        }
      ]
    }
  ]
}

Fetched Search Individual.