Registration

Campaign Registration Service APIs

Facilitates the registration of households to campaigns.

Register a Household to a Campaign.

post

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

Body

application/json

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

Responses

200

Household created successfully.

application/json

400

Bad request

application/json

500

Internal server error

application/json

post

/household/v1/_create

HTTPcURLJavaScriptPython

POST /registration/household/v1/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 774

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "householdRegistration": {
    "tenantId": "tenantA",
    "campaignId": "CAMP-001",
    "clientReferenceId": "GUID",
    "noOfIndividuals": 4,
    "address": "Address XYZ",
    "dateOfRegistration": 1663218161,
    "location": {
      "latitude": 18.22,
      "longitude": 71,
      "accuracy": 9
    },
    "administrativeUnit": "SOLIMBO",
    "individuals": [
      {
        "name": "text",
        "dateOfBirth": "YYYYMMDD",
        "mode": "CREATE",
        "gender": "MALE",
        "isHead": true,
        "identifiers": [
          {
            "type": "SYSTEM_GENERATED",
            "identifierId": "ABCD-1212"
          }
        ],
        "additionalFields": {
          "schema": "HOUSEHOLD",
          "version": 2,
          "fields": [
            {
              "key": "height",
              "value": 180
            }
          ]
        }
      }
    ],
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    }
  }
}

{
  "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",
    "individuals": [
      {
        "name": "text",
        "dateOfBirth": "YYYYMMDD",
        "registrationId": "R-ID-1",
        "gender": "MALE",
        "isHead": true,
        "identifiers": [
          {
            "type": "SYSTEM_GENERATED",
            "identifierId": "ABCD-1212"
          }
        ],
        "additionalFields": {
          "schema": "HOUSEHOLD",
          "version": 2,
          "fields": [
            {
              "key": "height",
              "value": 180
            }
          ]
        }
      }
    ],
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Update A Household Campaign Registration.

post

Update A Household, Ok response is returned.

Body

application/json

The request object, containing all necessary information for updating an HouseHold Registration and the request body metadata

householdRegistrationall ofRequired

Responses

200

Updated Household Registration successfully.

application/json

400

Bad request

application/json

500

Internal server error

application/json

post

/household/v1/_update

HTTPcURLJavaScriptPython

POST /registration/household/v1/_update HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 840

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "householdRegistration": {
    "id": "CAMPAIGN-ID",
    "registrationId": "ID-1",
    "householdId": "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",
    "individuals": [
      {
        "name": "text",
        "dateOfBirth": "YYYYMMDD",
        "mode": "CREATE",
        "gender": "MALE",
        "isHead": true,
        "identifiers": [
          {
            "type": "SYSTEM_GENERATED",
            "identifierId": "ABCD-1212"
          }
        ],
        "additionalFields": {
          "schema": "HOUSEHOLD",
          "version": 2,
          "fields": [
            {
              "key": "height",
              "value": 180
            }
          ]
        }
      }
    ],
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    }
  }
}

{
  "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",
    "individuals": [
      {
        "name": "text",
        "dateOfBirth": "YYYYMMDD",
        "registrationId": "R-ID-1",
        "gender": "MALE",
        "isHead": true,
        "identifiers": [
          {
            "type": "SYSTEM_GENERATED",
            "identifierId": "ABCD-1212"
          }
        ],
        "additionalFields": {
          "schema": "HOUSEHOLD",
          "version": 2,
          "fields": [
            {
              "key": "height",
              "value": 180
            }
          ]
        }
      }
    ],
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    }
  }
}

Search Household Registrations to a Campaign.

post

Search Household Registrations Ok response is returned.

Body

application/json

The request object, containing all necessary information for updating an household Registration and the request body metadata

Responses

200

Fetched Search Household.

application/json

400

Bad request

application/json

500

Internal server error

application/json

post

/household/v1/_search

HTTPcURLJavaScriptPython

POST /registration/household/v1/_search HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 277

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "householdRegistrationSearchCriteria": {
    "clientReferenceId": "GUID",
    "householdId": "H-ID",
    "createdBy": "UUID",
    "limit": 5,
    "offset": 5
  }
}

{
  "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",
      "individuals": [
        {
          "name": "text",
          "dateOfBirth": "YYYYMMDD",
          "registrationId": "R-ID-1",
          "gender": "MALE",
          "isHead": true,
          "identifiers": [
            {
              "type": "SYSTEM_GENERATED",
              "identifierId": "ABCD-1212"
            }
          ],
          "additionalFields": {
            "schema": "HOUSEHOLD",
            "version": 2,
            "fields": [
              {
                "key": "height",
                "value": 180
              }
            ]
          }
        }
      ],
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ]
}

Create a Individual Registration.

post

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

Body

application/json

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

Responses

200

Individual created successfully.

application/json

400

Bad request

application/json

500

Internal server error

application/json

post

/individual/v1/_create

HTTPcURLJavaScriptPython

POST /registration/individual/v1/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 617

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "individualRegistration": {
    "tenantId": "tenantA",
    "campaignId": "CAMP-001",
    "name": "John Doe",
    "dateOfBirth": 1663218161,
    "gender": "MALE",
    "address": "Address XYZ",
    "dateOfRegistration": 1663218161,
    "clientReferenceId": "GUID",
    "location": {
      "latitude": 18.22,
      "longitude": 71,
      "accuracy": 9
    },
    "administrativeUnit": "SOLIMBO",
    "identifiers": [
      {
        "type": "SYSTEM_GENERATED",
        "identifierId": "ABCD-1212"
      }
    ],
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    }
  }
}

{
  "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,
    "gender": "MALE",
    "address": "Address XYZ",
    "dateOfRegistration": 1663218161,
    "clientReferenceId": "GUID",
    "location": {
      "latitude": 18.22,
      "longitude": 71,
      "accuracy": 9
    },
    "administrativeUnit": "SOLIMBO",
    "identifiers": [
      {
        "type": "SYSTEM_GENERATED",
        "identifierId": "ABCD-1212"
      }
    ],
    "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",
        "gender": "MALE",
        "isHead": true,
        "identifiers": [
          {
            "type": "SYSTEM_GENERATED",
            "identifierId": "ABCD-1212"
          }
        ],
        "additionalFields": {
          "schema": "HOUSEHOLD",
          "version": 2,
          "fields": [
            {
              "key": "height",
              "value": 180
            }
          ]
        }
      }
    ]
  }
}

Update An Individual.

post

Update An Individual, Ok response is returned.

Body

application/json

The request object, containing all necessary information for updating an individual and the request body metadata

individualRegistrationall ofRequired

Responses

200

Updated Individual successfully.

application/json

400

Bad request

application/json

500

Internal server error

application/json

post

/individual/v1/_update

HTTPcURLJavaScriptPython

POST /registration/individual/v1/_update HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 660

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "individualRegistration": {
    "id": "CAMPAIGN-ID",
    "registrationId": "ID-1",
    "tenantId": "tenantA",
    "campaignId": "CAMP-001",
    "name": "John Doe",
    "dateOfBirth": 1663218161,
    "gender": "MALE",
    "address": "Address XYZ",
    "dateOfRegistration": 1663218161,
    "clientReferenceId": "GUID",
    "location": {
      "latitude": 18.22,
      "longitude": 71,
      "accuracy": 9
    },
    "administrativeUnit": "SOLIMBO",
    "identifiers": [
      {
        "type": "SYSTEM_GENERATED",
        "identifierId": "ABCD-1212"
      }
    ],
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    }
  }
}

{
  "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,
    "gender": "MALE",
    "address": "Address XYZ",
    "dateOfRegistration": 1663218161,
    "clientReferenceId": "GUID",
    "location": {
      "latitude": 18.22,
      "longitude": 71,
      "accuracy": 9
    },
    "administrativeUnit": "SOLIMBO",
    "identifiers": [
      {
        "type": "SYSTEM_GENERATED",
        "identifierId": "ABCD-1212"
      }
    ],
    "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",
        "gender": "MALE",
        "isHead": true,
        "identifiers": [
          {
            "type": "SYSTEM_GENERATED",
            "identifierId": "ABCD-1212"
          }
        ],
        "additionalFields": {
          "schema": "HOUSEHOLD",
          "version": 2,
          "fields": [
            {
              "key": "height",
              "value": 180
            }
          ]
        }
      }
    ]
  }
}

Search Individual Registrations.

post

Search Individual Registrations Ok response is returned.

Body

application/json

The request object, containing all necessary information for updating an Individual and the request body metadata

Responses

200

Fetched Search Individual.

application/json

400

Bad request

application/json

500

Internal server error

application/json

post

/individual/v1/_search

HTTPcURLJavaScriptPython

POST /registration/individual/v1/_search HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 319

{
  "requestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text"
  },
  "individualRegistrationSearchCriteria": {
    "clientReferenceId": "GUID",
    "campaignId": "H-ID",
    "registrationId": "ID-1",
    "name": "John Doe",
    "createdBy": "UUID",
    "limit": 5,
    "offset": 5
  }
}

{
  "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,
      "gender": "MALE",
      "address": "Address XYZ",
      "dateOfRegistration": 1663218161,
      "clientReferenceId": "GUID",
      "location": {
        "latitude": 18.22,
        "longitude": 71,
        "accuracy": 9
      },
      "administrativeUnit": "SOLIMBO",
      "identifiers": [
        {
          "type": "SYSTEM_GENERATED",
          "identifierId": "ABCD-1212"
        }
      ],
      "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",
          "gender": "MALE",
          "isHead": true,
          "identifiers": [
            {
              "type": "SYSTEM_GENERATED",
              "identifierId": "ABCD-1212"
            }
          ],
          "additionalFields": {
            "schema": "HOUSEHOLD",
            "version": 2,
            "fields": [
              {
                "key": "height",
                "value": 180
              }
            ]
          }
        }
      ]
    }
  ]
}