Household

Household Registry

Manage and maintain household registries.

Create/Add a new household

Create a new household

post

/household/v1/_create

Query parameters

echoResourceboolean · default: true

Client can specify if the resource in request body needs to be sent back in the response. This is being used to limit amount of data that needs to flow back from the server to the client in low bandwidth scenarios. Server will always send the server generated id for validated requests.

Body

RequestInfoobjectrequired

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.

Householdobjectrequired

A representation of Household.

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/household/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"Household":{"tenantId":"tenantA","memberCount":4,"address":{"tenantId":"tenantA","locality":{"code":"text","name":"text","children":[{"code":"text","name":"text","children":"[Circular Reference]"}]}},"additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{}}}'

202

400

500

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Household": {
    "id": "text",
    "tenantId": "tenantA",
    "clientReferenceId": "text",
    "memberCount": 4,
    "address": {
      "tenantId": "tenantA",
      "locality": {
        "code": "text",
        "name": "text",
        "children": [
          {
            "code": "text",
            "name": "text",
            "children": "[Circular Reference]"
          }
        ]
      }
    },
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {}
  }
}

Accepted

Create/Add new households in bulk

Create a new household in bulk

post

/household/v1/bulk/_create

Query parameters

echoResourceboolean · default: true

Client can specify if the resource in request body needs to be sent back in the response. This is being used to limit amount of data that needs to flow back from the server to the client in low bandwidth scenarios. Server will always send the server generated id for validated requests.

Body

RequestInfoobjectrequired

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.

Householdsobject[]

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/household/v1/bulk/_create' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"Households":[{"tenantId":"tenantA","memberCount":4,"address":{"tenantId":"tenantA","locality":{"code":"text","name":"text","children":[{"code":"text","name":"text","children":"[Circular Reference]"}]}},"additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{}}]}'

202

400

500

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

Accepted

Update the details of a existing household

Update the details of a existing household

post

/household/v1/_update

Query parameters

echoResourceboolean · default: true

Client can specify if the resource in request body needs to be sent back in the response. This is being used to limit amount of data that needs to flow back from the server to the client in low bandwidth scenarios. Server will always send the server generated id for validated requests.

Body

RequestInfoobjectrequired

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.

Householdobjectrequired

A representation of Household.

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/household/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"Household":{"tenantId":"tenantA","memberCount":4,"address":{"tenantId":"tenantA","locality":{"code":"text","name":"text","children":[{"code":"text","name":"text","children":"[Circular Reference]"}]}},"additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{}}}'

202

400

500

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Household": {
    "id": "text",
    "tenantId": "tenantA",
    "clientReferenceId": "text",
    "memberCount": 4,
    "address": {
      "tenantId": "tenantA",
      "locality": {
        "code": "text",
        "name": "text",
        "children": [
          {
            "code": "text",
            "name": "text",
            "children": "[Circular Reference]"
          }
        ]
      }
    },
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {}
  }
}

Accepted

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

echoResourceboolean · default: true

Client can specify if the resource in request body needs to be sent back in the response. This is being used to limit amount of data that needs to flow back from the server to the client in low bandwidth scenarios. Server will always send the server generated id for validated requests.

Body

RequestInfoobjectrequired

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.

Householdsobject[]

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/household/v1/bulk/_update' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"Households":[{"tenantId":"tenantA","memberCount":4,"address":{"tenantId":"tenantA","locality":{"code":"text","name":"text","children":[{"code":"text","name":"text","children":"[Circular Reference]"}]}},"additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{}}]}'

202

400

500

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

Accepted

Soft delete the details of a existing household

Soft delete the details of a existing household

post

/household/v1/_delete

Query parameters

echoResourceboolean · default: true

Client can specify if the resource in request body needs to be sent back in the response. This is being used to limit amount of data that needs to flow back from the server to the client in low bandwidth scenarios. Server will always send the server generated id for validated requests.

Body

RequestInfoobjectrequired

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.

Householdobjectrequired

A representation of Household.

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/household/v1/_delete' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"Household":{"tenantId":"tenantA","memberCount":4,"address":{"tenantId":"tenantA","locality":{"code":"text","name":"text","children":[{"code":"text","name":"text","children":"[Circular Reference]"}]}},"additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{}}}'

202

400

500

202

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "msgId": "text",
    "userInfo": {
      "tenantId": "text",
      "userName": "text",
      "primaryrole": [
        {
          "name": "text"
        }
      ],
      "additionalroles": [
        {
          "tenantId": "text",
          "roles": [
            {
              "name": "text"
            }
          ]
        }
      ]
    }
  },
  "Household": {
    "tenantId": "tenantA",
    "memberCount": 4,
    "address": {
      "tenantId": "tenantA",
      "locality": {
        "code": "text",
        "name": "text",
        "children": [
          {
            "code": "text",
            "name": "text",
            "children": "[Circular Reference]"
          }
        ]
      }
    },
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "auditDetails": {}
  }
}

Accepted

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

echoResourceboolean · default: true

Client can specify if the resource in request body needs to be sent back in the response. This is being used to limit amount of data that needs to flow back from the server to the client in low bandwidth scenarios. Server will always send the server generated id for validated requests.

Body

RequestInfoobjectrequired

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.

Householdsobject[]

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/household/v1/bulk/_delete' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"Households":[{"tenantId":"tenantA","memberCount":4,"address":{"tenantId":"tenantA","locality":{"code":"text","name":"text","children":[{"code":"text","name":"text","children":"[Circular Reference]"}]}},"additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{}}]}'

202

400

500

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

Accepted

Search existing household

Search existing household

post

/household/v1/_search

Query parameters

limitinteger · max: 1000required

Pagination - limit records in response

offsetintegerrequired

Pagination - offset from which records should be returned in response

tenantIdstring · varcharrequired

Unique id for a tenant.

lastChangedSinceinteger · int64

epoch of the time since when the changes on the object should be picked up. Search results from this parameter should include both newly created objects since this time as well as any modified objects since this time. This criterion is included to help polling clients to get the changes in system since a last time they synchronized with the platform.

includeDeletedboolean

Used in search APIs to specify if (soft) deleted records should be included in search results.

Body

RequestInfoobjectrequired

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.

Householdobjectrequired

A representation of Household.

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/household/v1/_search?limit=1&offset=1&tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"Household":{"id":[null],"clientReferenceId":[null]}}'

200

400

500

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Households": [
    {
      "id": "text",
      "tenantId": "tenantA",
      "clientReferenceId": "text",
      "memberCount": 4,
      "address": {
        "tenantId": "tenantA",
        "locality": {
          "code": "text",
          "name": "text",
          "children": [
            {
              "code": "text",
              "name": "text",
              "children": "[Circular Reference]"
            }
          ]
        }
      },
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {}
    }
  ]
}

Ok

Add a new household member

Add a new member to household

post

/household/member/v1/_create

Query parameters

echoResourceboolean · default: true

Client can specify if the resource in request body needs to be sent back in the response. This is being used to limit amount of data that needs to flow back from the server to the client in low bandwidth scenarios. Server will always send the server generated id for validated requests.

Body

RequestInfoobjectrequired

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.

HouseholdMemberobject

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

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/household/member/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"HouseholdMember":{"householdId":"text","individualId":"text","isHeadOfHousehold":false,"tenantId":"tenantA","additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{}}}'

202

400

500

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "HouseholdMember": {
    "id": "text",
    "householdId": "text",
    "householdClientReferenceId": "text",
    "individualId": "text",
    "individualClientReferenceId": "text",
    "isHeadOfHousehold": false,
    "tenantId": "tenantA",
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {}
  }
}

Accepted

Add new household members in bulk

Add new members to household in bulk

post

/household/member/v1/bulk/_create

Query parameters

echoResourceboolean · default: true

Client can specify if the resource in request body needs to be sent back in the response. This is being used to limit amount of data that needs to flow back from the server to the client in low bandwidth scenarios. Server will always send the server generated id for validated requests.

Body

RequestInfoobjectrequired

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.

HouseholdMembersobject[]

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/household/member/v1/bulk/_create' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"HouseholdMembers":[{"householdId":"text","individualId":"text","isHeadOfHousehold":false,"tenantId":"tenantA","additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{}}]}'

202

400

500

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

Accepted

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

echoResourceboolean · default: true

Client can specify if the resource in request body needs to be sent back in the response. This is being used to limit amount of data that needs to flow back from the server to the client in low bandwidth scenarios. Server will always send the server generated id for validated requests.

Body

RequestInfoobjectrequired

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.

HouseholdMemberobject

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

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/household/member/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"HouseholdMember":{"householdId":"text","individualId":"text","isHeadOfHousehold":false,"tenantId":"tenantA","additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{}}}'

202

400

500

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Household": {
    "id": "text",
    "tenantId": "tenantA",
    "clientReferenceId": "text",
    "memberCount": 4,
    "address": {
      "tenantId": "tenantA",
      "locality": {
        "code": "text",
        "name": "text",
        "children": [
          {
            "code": "text",
            "name": "text",
            "children": "[Circular Reference]"
          }
        ]
      }
    },
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {}
  }
}

Accepted

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

echoResourceboolean · default: true

Client can specify if the resource in request body needs to be sent back in the response. This is being used to limit amount of data that needs to flow back from the server to the client in low bandwidth scenarios. Server will always send the server generated id for validated requests.

Body

RequestInfoobjectrequired

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.

HouseholdMembersobject[]

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/household/member/v1/bulk/_update' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"HouseholdMembers":[{"householdId":"text","individualId":"text","isHeadOfHousehold":false,"tenantId":"tenantA","additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{}}]}'

202

400

500

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

Accepted

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

echoResourceboolean · default: true

Client can specify if the resource in request body needs to be sent back in the response. This is being used to limit amount of data that needs to flow back from the server to the client in low bandwidth scenarios. Server will always send the server generated id for validated requests.

Body

RequestInfoobjectrequired

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.

HouseholdMemberobject

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

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/household/member/v1/_delete' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"HouseholdMember":{"householdId":"text","individualId":"text","isHeadOfHousehold":false,"tenantId":"tenantA","additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{}}}'

202

400

500

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "HouseholdMember": {
    "id": "text",
    "householdId": "text",
    "householdClientReferenceId": "text",
    "individualId": "text",
    "individualClientReferenceId": "text",
    "isHeadOfHousehold": false,
    "tenantId": "tenantA",
    "additionalFields": {
      "schema": "HOUSEHOLD",
      "version": 2,
      "fields": [
        {
          "key": "height",
          "value": 180
        }
      ]
    },
    "isDeleted": true,
    "rowVersion": 1,
    "auditDetails": {}
  }
}

Accepted

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

echoResourceboolean · default: true

Client can specify if the resource in request body needs to be sent back in the response. This is being used to limit amount of data that needs to flow back from the server to the client in low bandwidth scenarios. Server will always send the server generated id for validated requests.

Body

RequestInfoobjectrequired

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.

HouseholdMembersobject[]

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/household/member/v1/bulk/_delete' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"HouseholdMembers":[{"householdId":"text","individualId":"text","isHeadOfHousehold":false,"tenantId":"tenantA","additionalFields":{"schema":"HOUSEHOLD","version":2,"fields":[{"key":"height","value":180}]},"auditDetails":{}}]}'

202

400

500

202

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  }
}

Accepted

Search existing household member

Search existing household member

post

/household/member/v1/_search

Query parameters

limitinteger · max: 1000required

Pagination - limit records in response

offsetintegerrequired

Pagination - offset from which records should be returned in response

tenantIdstring · varcharrequired

Unique id for a tenant.

lastChangedSinceinteger · int64

epoch of the time since when the changes on the object should be picked up. Search results from this parameter should include both newly created objects since this time as well as any modified objects since this time. This criterion is included to help polling clients to get the changes in system since a last time they synchronized with the platform.

includeDeletedboolean

Used in search APIs to specify if (soft) deleted records should be included in search results.

Body

RequestInfoobjectrequired

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.

HouseholdMemberobjectrequired

Search model for household member

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/household/member/v1/_search?limit=1&offset=1&tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"HouseholdMember":{"id":[null]}}'

200

400

500

200

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "HouseholdMembers": [
    {
      "id": "text",
      "householdId": "text",
      "householdClientReferenceId": "text",
      "individualId": "text",
      "individualClientReferenceId": "text",
      "isHeadOfHousehold": false,
      "tenantId": "tenantA",
      "additionalFields": {
        "schema": "HOUSEHOLD",
        "version": 2,
        "fields": [
          {
            "key": "height",
            "value": 180
          }
        ]
      },
      "isDeleted": true,
      "rowVersion": 1,
      "auditDetails": {}
    }
  ]
}

Ok