Household

Household Registry

Manage and maintain household registries.

Create/Add a new household

Create a new household

POST/household/v1/_create

Query parameters

Body

application/json

Capture details of Household.

Household*Household (object)

A representation of Household.

Response

202400500

Accepted

Body

*/*

HouseholdHousehold (object)

A representation of Household.

Request

JavaScriptCurlPython

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

Response

202

{
  "Household": {
    "memberCount": 4
  }
}

Create/Add new households in bulk

Create a new household in bulk

POST/household/v1/bulk/_create

Query parameters

Body

application/json

Capture details of Household.

Householdsarray of Household (object)

Response

202400500

Accepted

Body

*/*

BulkResponse (object)

Request

JavaScriptCurlPython

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

Response

202

{}

Update the details of a existing household

Update the details of a existing household

POST/household/v1/_update

Query parameters

Body

application/json

Details for existing household.

Household*Household (object)

A representation of Household.

Response

202400500

Accepted

Body

*/*

HouseholdHousehold (object)

A representation of Household.

Request

JavaScriptCurlPython

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

Response

202

{
  "Household": {
    "memberCount": 4
  }
}

Update the details of a existing household in bulk

Update the details of a existing household in bulk

POST/household/v1/bulk/_update

Query parameters

Body

application/json

Details for existing household.

Householdsarray of Household (object)

Response

202400500

Accepted

Body

*/*

BulkResponse (object)

Request

JavaScriptCurlPython

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

Response

202

{}

Soft delete the details of a existing household

Soft delete the details of a existing household

POST/household/v1/_delete

Query parameters

Body

application/json

Details for the household.

Household*Household (object)

A representation of Household.

Response

202400500

Accepted

Body

*/*

Household*Household (object)

A representation of Household.

Request

JavaScriptCurlPython

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

Response

202

{
  "Household": {
    "memberCount": 4
  }
}

Soft delete the details of an existing households in bulk

Soft delete the details of an existing households in bulk

POST/household/v1/bulk/_delete

Query parameters

Body

application/json

Details for the Household.

Householdsarray of Household (object)

Response

202400500

Accepted

Body

*/*

BulkResponse (object)

Request

JavaScriptCurlPython

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

Response

202

{}

Search existing household

Search existing household

POST/household/v1/_search

Query parameters

Body

application/json

Details for existing household.

Household*HouseholdSearch (object)

A representation of Household.

Response

200400500

Ok

Body

*/*

Householdsarray of Household (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "Households": [
    {
      "memberCount": 4
    }
  ]
}

Add a new household member

Add a new member to household

POST/household/member/v1/_create

Query parameters

Body

application/json

Capture linkage of Household to Member.

HouseholdMemberHouseholdMember (object)

A representation of a household member (already registered as an individual)

Response

202400500

Accepted

Body

*/*

HouseholdMemberHouseholdMember (object)

A representation of a household member (already registered as an individual)

Request

JavaScriptCurlPython

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

Response

202

{
  "HouseholdMember": {
    "isHeadOfHousehold": false
  }
}

Add new household members in bulk

Add new members to household in bulk

POST/household/member/v1/bulk/_create

Query parameters

Body

application/json

Capture linkage of Household to Member.

HouseholdMembersarray of HouseholdMember (object)

Response

202400500

Accepted

Body

*/*

BulkResponse (object)

Request

JavaScriptCurlPython

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

Response

202

{}

Update the linkage details of an existing household member

Update the linkage details of an existing household member

POST/household/member/v1/_update

Query parameters

Body

application/json

Linkage details for existing household member.

HouseholdMemberHouseholdMember (object)

A representation of a household member (already registered as an individual)

Response

202400500

Accepted

Body

*/*

HouseholdHousehold (object)

A representation of Household.

Request

JavaScriptCurlPython

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

Response

202

{
  "Household": {
    "memberCount": 4
  }
}

Update the linkage details of an existing household members in bulk

Update the linkage details of an existing household members in bulk

POST/household/member/v1/bulk/_update

Query parameters

Body

application/json

Linkage details for existing household members.

HouseholdMembersarray of HouseholdMember (object)

Response

202400500

Accepted

Body

*/*

BulkResponse (object)

Request

JavaScriptCurlPython

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

Response

202

{}

Soft delete the linking of existing household member household

Soft delete the linking of an existing household member from a household

POST/household/member/v1/_delete

Query parameters

Body

application/json

Details for the household member.

HouseholdMemberHouseholdMember (object)

A representation of a household member (already registered as an individual)

Response

202400500

Accepted

Body

*/*

HouseholdMemberHouseholdMember (object)

A representation of a household member (already registered as an individual)

Request

JavaScriptCurlPython

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

Response

202

{
  "HouseholdMember": {
    "isHeadOfHousehold": false
  }
}

Soft delete the linking of existing household members in bulk from a household

Soft delete the linking of an existing households in bulk from a household

POST/household/member/v1/bulk/_delete

Query parameters

Body

application/json

Details for the Household.

HouseholdMembersarray of HouseholdMember (object)

Response

202400500

Accepted

Body

*/*

BulkResponse (object)

Request

JavaScriptCurlPython

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

Response

202

{}

Search existing household member

Search existing household member

POST/household/member/v1/_search

Query parameters

Body

application/json

Details for existing household member.

HouseholdMember*HouseholdMemberSearch (object)

Search model for household member

Response

200400500

Ok

Body

*/*

any

Request

JavaScriptCurlPython

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