Household
Household Registry
Manage and maintain household registries.
Create a new household
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.
POST /household/v1/_create HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 807
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"Household": {
"tenantId": "tenantA",
"clientReferenceId": "text",
"memberCount": 4,
"address": {
"tenantId": "tenantA",
"doorNo": "text",
"latitude": 1,
"longitude": 1,
"locationAccuracy": 1,
"type": [
"PERMANENT"
],
"addressLine1": "text",
"addressLine2": "text",
"landmark": "text",
"city": "text",
"pincode": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]"
}
]
}
},
"additionalFields": {
"schema": "HOUSEHOLD",
"version": 2,
"fields": [
{
"key": "height",
"value": 180
}
]
},
"rowVersion": 1
}
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"Household": {
"id": "text",
"tenantId": "tenantA",
"clientReferenceId": "text",
"memberCount": 4,
"address": {
"id": "text",
"tenantId": "tenantA",
"doorNo": "text",
"latitude": 1,
"longitude": 1,
"locationAccuracy": 1,
"type": [
"PERMANENT"
],
"addressLine1": "text",
"addressLine2": "text",
"landmark": "text",
"city": "text",
"pincode": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]",
"materializedPath": "text"
}
],
"materializedPath": "text"
}
},
"additionalFields": {
"schema": "HOUSEHOLD",
"version": 2,
"fields": [
{
"key": "height",
"value": 180
}
]
},
"isDeleted": true,
"rowVersion": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
}Create a new household in bulk
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.
POST /household/v1/bulk/_create HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 717
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"Households": [
{
"tenantId": "tenantA",
"clientReferenceId": "text",
"memberCount": 4,
"address": {
"tenantId": "tenantA",
"doorNo": "text",
"latitude": 1,
"longitude": 1,
"locationAccuracy": 1,
"type": [
"PERMANENT"
],
"addressLine1": "text",
"addressLine2": "text",
"landmark": "text",
"city": "text",
"pincode": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
"[Circular Reference]"
]
}
},
"additionalFields": {
"schema": "HOUSEHOLD",
"version": 2,
"fields": [
{
"key": "height",
"value": 180
}
]
},
"rowVersion": 1
}
]
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
}
}Update the details of a existing household
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.
POST /household/v1/_update HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 807
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"Household": {
"tenantId": "tenantA",
"clientReferenceId": "text",
"memberCount": 4,
"address": {
"tenantId": "tenantA",
"doorNo": "text",
"latitude": 1,
"longitude": 1,
"locationAccuracy": 1,
"type": [
"PERMANENT"
],
"addressLine1": "text",
"addressLine2": "text",
"landmark": "text",
"city": "text",
"pincode": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]"
}
]
}
},
"additionalFields": {
"schema": "HOUSEHOLD",
"version": 2,
"fields": [
{
"key": "height",
"value": 180
}
]
},
"rowVersion": 1
}
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"Household": {
"id": "text",
"tenantId": "tenantA",
"clientReferenceId": "text",
"memberCount": 4,
"address": {
"id": "text",
"tenantId": "tenantA",
"doorNo": "text",
"latitude": 1,
"longitude": 1,
"locationAccuracy": 1,
"type": [
"PERMANENT"
],
"addressLine1": "text",
"addressLine2": "text",
"landmark": "text",
"city": "text",
"pincode": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]",
"materializedPath": "text"
}
],
"materializedPath": "text"
}
},
"additionalFields": {
"schema": "HOUSEHOLD",
"version": 2,
"fields": [
{
"key": "height",
"value": 180
}
]
},
"isDeleted": true,
"rowVersion": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
}Update the details of a existing household in bulk
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.
POST /household/v1/bulk/_update HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 717
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"Households": [
{
"tenantId": "tenantA",
"clientReferenceId": "text",
"memberCount": 4,
"address": {
"tenantId": "tenantA",
"doorNo": "text",
"latitude": 1,
"longitude": 1,
"locationAccuracy": 1,
"type": [
"PERMANENT"
],
"addressLine1": "text",
"addressLine2": "text",
"landmark": "text",
"city": "text",
"pincode": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
"[Circular Reference]"
]
}
},
"additionalFields": {
"schema": "HOUSEHOLD",
"version": 2,
"fields": [
{
"key": "height",
"value": 180
}
]
},
"rowVersion": 1
}
]
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
}
}Soft delete the details of a existing household
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.
POST /household/v1/_delete HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 807
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"Household": {
"tenantId": "tenantA",
"clientReferenceId": "text",
"memberCount": 4,
"address": {
"tenantId": "tenantA",
"doorNo": "text",
"latitude": 1,
"longitude": 1,
"locationAccuracy": 1,
"type": [
"PERMANENT"
],
"addressLine1": "text",
"addressLine2": "text",
"landmark": "text",
"city": "text",
"pincode": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]"
}
]
}
},
"additionalFields": {
"schema": "HOUSEHOLD",
"version": 2,
"fields": [
{
"key": "height",
"value": 180
}
]
},
"rowVersion": 1
}
}{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "text"
}
]
}
]
},
"correlationId": "text"
},
"Household": {
"id": "text",
"tenantId": "tenantA",
"clientReferenceId": "text",
"memberCount": 4,
"address": {
"id": "text",
"tenantId": "tenantA",
"doorNo": "text",
"latitude": 1,
"longitude": 1,
"locationAccuracy": 1,
"type": [
"PERMANENT"
],
"addressLine1": "text",
"addressLine2": "text",
"landmark": "text",
"city": "text",
"pincode": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]",
"materializedPath": "text"
}
],
"materializedPath": "text"
}
},
"additionalFields": {
"schema": "HOUSEHOLD",
"version": 2,
"fields": [
{
"key": "height",
"value": 180
}
]
},
"isDeleted": true,
"rowVersion": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
}Soft delete the details of an existing households in bulk
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.
POST /household/v1/bulk/_delete HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 717
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"Households": [
{
"tenantId": "tenantA",
"clientReferenceId": "text",
"memberCount": 4,
"address": {
"tenantId": "tenantA",
"doorNo": "text",
"latitude": 1,
"longitude": 1,
"locationAccuracy": 1,
"type": [
"PERMANENT"
],
"addressLine1": "text",
"addressLine2": "text",
"landmark": "text",
"city": "text",
"pincode": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
"[Circular Reference]"
]
}
},
"additionalFields": {
"schema": "HOUSEHOLD",
"version": 2,
"fields": [
{
"key": "height",
"value": 180
}
]
},
"rowVersion": 1
}
]
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
}
}Search existing household
Pagination - limit records in response
Pagination - offset from which records should be returned in response
Unique id for a tenant.
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.
Used in search APIs to specify if (soft) deleted records should be included in search results.
POST /household/v1/_search?limit=null&offset=null&tenantId=null HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 228
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"Household": {
"id": [
"text"
],
"clientReferenceId": [
"text"
],
"boundaryCode": "text"
}
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"Households": [
{
"id": "text",
"tenantId": "tenantA",
"clientReferenceId": "text",
"memberCount": 4,
"address": {
"id": "text",
"tenantId": "tenantA",
"doorNo": "text",
"latitude": 1,
"longitude": 1,
"locationAccuracy": 1,
"type": [
"PERMANENT"
],
"addressLine1": "text",
"addressLine2": "text",
"landmark": "text",
"city": "text",
"pincode": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
"[Circular Reference]"
],
"materializedPath": "text"
}
},
"additionalFields": {
"schema": "HOUSEHOLD",
"version": 2,
"fields": [
{
"key": "height",
"value": 180
}
]
},
"isDeleted": true,
"rowVersion": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}Add a new member to household
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.
POST /household/member/v1/_create HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 398
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"HouseholdMember": {
"householdClientReferenceId": "text",
"individualClientReferenceId": "text",
"isHeadOfHousehold": false,
"tenantId": "tenantA",
"additionalFields": {
"schema": "HOUSEHOLD",
"version": 2,
"fields": [
{
"key": "height",
"value": 180
}
]
},
"rowVersion": 1
}
}{
"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": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
}Add new members to household in bulk
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.
POST /household/member/v1/bulk/_create HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 401
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"HouseholdMembers": [
{
"householdClientReferenceId": "text",
"individualClientReferenceId": "text",
"isHeadOfHousehold": false,
"tenantId": "tenantA",
"additionalFields": {
"schema": "HOUSEHOLD",
"version": 2,
"fields": [
{
"key": "height",
"value": 180
}
]
},
"rowVersion": 1
}
]
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
}
}Update the linkage details of an existing household member
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.
POST /household/member/v1/_update HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 398
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"HouseholdMember": {
"householdClientReferenceId": "text",
"individualClientReferenceId": "text",
"isHeadOfHousehold": false,
"tenantId": "tenantA",
"additionalFields": {
"schema": "HOUSEHOLD",
"version": 2,
"fields": [
{
"key": "height",
"value": 180
}
]
},
"rowVersion": 1
}
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"Household": {
"id": "text",
"tenantId": "tenantA",
"clientReferenceId": "text",
"memberCount": 4,
"address": {
"id": "text",
"tenantId": "tenantA",
"doorNo": "text",
"latitude": 1,
"longitude": 1,
"locationAccuracy": 1,
"type": [
"PERMANENT"
],
"addressLine1": "text",
"addressLine2": "text",
"landmark": "text",
"city": "text",
"pincode": "text",
"buildingName": "text",
"street": "text",
"locality": {
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": [
{
"code": "text",
"name": "text",
"label": "text",
"latitude": "text",
"longitude": "text",
"children": "[Circular Reference]",
"materializedPath": "text"
}
],
"materializedPath": "text"
}
},
"additionalFields": {
"schema": "HOUSEHOLD",
"version": 2,
"fields": [
{
"key": "height",
"value": 180
}
]
},
"isDeleted": true,
"rowVersion": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
}Update the linkage details of an existing household members in bulk
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.
POST /household/member/v1/bulk/_update HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 401
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"HouseholdMembers": [
{
"householdClientReferenceId": "text",
"individualClientReferenceId": "text",
"isHeadOfHousehold": false,
"tenantId": "tenantA",
"additionalFields": {
"schema": "HOUSEHOLD",
"version": 2,
"fields": [
{
"key": "height",
"value": 180
}
]
},
"rowVersion": 1
}
]
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
}
}Soft delete the linking of an existing household member from a household
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.
POST /household/member/v1/_delete HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 398
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"HouseholdMember": {
"householdClientReferenceId": "text",
"individualClientReferenceId": "text",
"isHeadOfHousehold": false,
"tenantId": "tenantA",
"additionalFields": {
"schema": "HOUSEHOLD",
"version": 2,
"fields": [
{
"key": "height",
"value": 180
}
]
},
"rowVersion": 1
}
}{
"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": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
}Soft delete the linking of an existing households in bulk from a household
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.
POST /household/member/v1/bulk/_delete HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 401
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"HouseholdMembers": [
{
"householdClientReferenceId": "text",
"individualClientReferenceId": "text",
"isHeadOfHousehold": false,
"tenantId": "tenantA",
"additionalFields": {
"schema": "HOUSEHOLD",
"version": 2,
"fields": [
{
"key": "height",
"value": 180
}
]
},
"rowVersion": 1
}
]
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
}
}Search existing household member
Pagination - limit records in response
Pagination - offset from which records should be returned in response
Unique id for a tenant.
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.
Used in search APIs to specify if (soft) deleted records should be included in search results.
POST /household/member/v1/_search?limit=null&offset=null&tenantId=null HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 281
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"HouseholdMember": {
"id": [
"text"
],
"householdClientReferenceId": "text",
"individualClientReferenceId": "text",
"isHeadOfHousehold": true
}
}{
"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": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}Last updated
Was this helpful?