Registration

Campaign Registration Service APIs

Facilitates the registration of households to campaigns.

Search Household Registrations to a Campaign.

Search Household Registrations Ok response is returned.

POST/registration/household/v1/_search

Body

application/json

Search Criteria for Household and RequestInfo meta data.

householdRegistrationSearchCriteriaobject

Response

200400500

Fetched Search Household.

Body

*/*

totalCountnumber

Example: 1

householdRegistrationarray of HouseholdResponse (object)

Request

JavaScriptCurlPythonHTTP

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

Response

200

{
  "totalCount": 1,
  "householdRegistration": [
    {
      "householdRegistrationId": "H-ID-1",
      "individuals": []
    }
  ]
}