DO.COM.09 HouseholdMember

A household member refers to an individual who belongs to a specific household. This data object is used to describe the attributes of the people who make up a household.

AttributeTypeCardinalityDescription

member_identifier*

0...1

A unique identifier assigned to each household member

household_identifier*

0...1

The identifier for a household that individuals are linked to

demographic_info*

0...1

Personal details of the household member

relationship_head*

0...1

Household Member's Relationship to the Head of the Household

related_person

0...*

Persons related to the household member and the relationship types

is_disabled*

0...1

Is the household member disabled?

disability_info

0...1

Additional attributes for people with disabilities

marital_status*

0...1

Marital status of the household member

employment_status

0...1

Employment status of the household member

occupation

0...1

Occupation of the household member

income_level

0...1

Income level of the household member

language_code

0...*

The languages spoken by the household member

education_level

0...1

Household members education level

additional_attributes

0...1

Additional characteristics of the household member

registration_date*

0...1

The date the household member was registered

last_updated

0...1

The date the household member was last updated

Example of JSON data for the Household member Data object

{
  "message": {
    "search_response": [
      {
        "response_entity": "HouseholdMember",
        "data": {
          "reg_records": [
            {
              "householdMember": {
                "member_identifier": "HS0205202401",
                "household_identifier": "HS02052024",
                "demographic_info": {
                  "person": {
                    "identifier_type": "NID",
                    "identifier_value": "0205202401",
                    "name": {
                      "first_name": "Test",
                      "second_name": "Test2",
                      "surname": "Test3"
                    },
                    "sex": "F",
                    "birth_date": "02.05.2004",
                    "death_date": "",
                    "address": "xxxxx",
                    "phone_number": "",
                    "email": "",
                    "relationship_head": "self",
                    "related_person": "",
                    "is_disabled": "0",
                    "disability_info": "",
                    "marital_status": "Single",
                    "employment_status": "employed",
                    "occupation": "Caregiver",
                    "income_level": "",
                    "language_code": "Eng",
                    "education_level": "Highschool",
                    "additional_attributes": "",
                    "registration_date": "02.05.2024",
                    "last_update": ""
                  }
                }
              }
            }
          ]
        }
      }
    ]
  }
}

Last updated