Individual
Individual Registry
Maintain and manage individual registries.
Create a new Individual
Query parameters
echoResourceanyOptional
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
Responses
202
Accepted
application/json
400
Bad Request
application/json
500
Internal Server Error
application/json
post
POST /individual/v1/_create HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 1149
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"Individual": {
"individualId": "text",
"tenantId": "tenantA",
"clientReferenceId": "text",
"name": {
"givenName": "text",
"familyName": "text",
"otherNames": "text"
},
"dateOfBirth": "14/10/2022",
"gender": "MALE",
"bloodGroup": [
"AB+"
],
"mobileNumber": "text",
"altContactNumber": "text",
"email": "[email protected]",
"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]"
]
}
}
],
"fatherName": "text",
"husbandName": "text",
"relationship": "text",
"identifiers": [
{
"identifierType": "SYSTEM_GENERATED",
"identifierId": "ABCD-1212"
}
],
"skills": [
{
"type": "text",
"level": "text",
"experience": "text"
}
],
"photo": "text",
"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"
},
"Individual": {
"id": "text",
"individualId": "text",
"tenantId": "tenantA",
"clientReferenceId": "text",
"userId": "text",
"name": {
"givenName": "text",
"familyName": "text",
"otherNames": "text"
},
"dateOfBirth": "14/10/2022",
"gender": "MALE",
"bloodGroup": [
"AB+"
],
"mobileNumber": "text",
"altContactNumber": "text",
"email": "[email protected]",
"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"
}
}
],
"fatherName": "text",
"husbandName": "text",
"relationship": "text",
"identifiers": [
{
"identifierType": "SYSTEM_GENERATED",
"identifierId": "ABCD-1212"
}
],
"skills": [
{
"id": "text",
"type": "text",
"level": "text",
"experience": "text"
}
],
"photo": "text",
"additionalFields": {
"schema": "HOUSEHOLD",
"version": 2,
"fields": [
{
"key": "height",
"value": 180
}
]
},
"isDeleted": true,
"isSystemUser": true,
"rowVersion": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
}Create a new Individuals
Query parameters
echoResourceanyOptional
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
Responses
202
Accepted
application/json
400
Bad Request
application/json
500
Internal Server Error
application/json
post
POST /individual/v1/bulk/_create HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 1150
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"Individuals": [
{
"individualId": "text",
"tenantId": "tenantA",
"clientReferenceId": "text",
"name": {
"givenName": "text",
"familyName": "text",
"otherNames": "text"
},
"dateOfBirth": "14/10/2022",
"gender": "MALE",
"bloodGroup": [
"AB+"
],
"mobileNumber": "text",
"altContactNumber": "text",
"email": "[email protected]",
"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]"
}
}
],
"fatherName": "text",
"husbandName": "text",
"relationship": "text",
"identifiers": [
{
"identifierType": "SYSTEM_GENERATED",
"identifierId": "ABCD-1212"
}
],
"skills": [
{
"type": "text",
"level": "text",
"experience": "text"
}
],
"photo": "text",
"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 Individual
Query parameters
echoResourceanyOptional
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
Responses
202
Accepted
application/json
400
Bad Request
application/json
500
Internal Server Error
application/json
post
POST /individual/v1/_update HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 1149
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"Individual": {
"individualId": "text",
"tenantId": "tenantA",
"clientReferenceId": "text",
"name": {
"givenName": "text",
"familyName": "text",
"otherNames": "text"
},
"dateOfBirth": "14/10/2022",
"gender": "MALE",
"bloodGroup": [
"AB+"
],
"mobileNumber": "text",
"altContactNumber": "text",
"email": "[email protected]",
"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]"
]
}
}
],
"fatherName": "text",
"husbandName": "text",
"relationship": "text",
"identifiers": [
{
"identifierType": "SYSTEM_GENERATED",
"identifierId": "ABCD-1212"
}
],
"skills": [
{
"type": "text",
"level": "text",
"experience": "text"
}
],
"photo": "text",
"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"
},
"Individual": {
"id": "text",
"individualId": "text",
"tenantId": "tenantA",
"clientReferenceId": "text",
"userId": "text",
"name": {
"givenName": "text",
"familyName": "text",
"otherNames": "text"
},
"dateOfBirth": "14/10/2022",
"gender": "MALE",
"bloodGroup": [
"AB+"
],
"mobileNumber": "text",
"altContactNumber": "text",
"email": "[email protected]",
"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"
}
}
],
"fatherName": "text",
"husbandName": "text",
"relationship": "text",
"identifiers": [
{
"identifierType": "SYSTEM_GENERATED",
"identifierId": "ABCD-1212"
}
],
"skills": [
{
"id": "text",
"type": "text",
"level": "text",
"experience": "text"
}
],
"photo": "text",
"additionalFields": {
"schema": "HOUSEHOLD",
"version": 2,
"fields": [
{
"key": "height",
"value": 180
}
]
},
"isDeleted": true,
"isSystemUser": true,
"rowVersion": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
}Update the details of existing Individuals
Query parameters
echoResourceanyOptional
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
Responses
202
Accepted
application/json
400
Bad Request
application/json
500
Internal Server Error
application/json
post
POST /individual/v1/bulk/_update HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 1150
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"Individuals": [
{
"individualId": "text",
"tenantId": "tenantA",
"clientReferenceId": "text",
"name": {
"givenName": "text",
"familyName": "text",
"otherNames": "text"
},
"dateOfBirth": "14/10/2022",
"gender": "MALE",
"bloodGroup": [
"AB+"
],
"mobileNumber": "text",
"altContactNumber": "text",
"email": "[email protected]",
"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]"
}
}
],
"fatherName": "text",
"husbandName": "text",
"relationship": "text",
"identifiers": [
{
"identifierType": "SYSTEM_GENERATED",
"identifierId": "ABCD-1212"
}
],
"skills": [
{
"type": "text",
"level": "text",
"experience": "text"
}
],
"photo": "text",
"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 Individual and nested entities
Query parameters
echoResourceanyOptional
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
Responses
202
Accepted
application/json
400
Bad Request
application/json
500
Internal Server Error
application/json
post
POST /individual/v1/_delete HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 1149
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"Individual": {
"individualId": "text",
"tenantId": "tenantA",
"clientReferenceId": "text",
"name": {
"givenName": "text",
"familyName": "text",
"otherNames": "text"
},
"dateOfBirth": "14/10/2022",
"gender": "MALE",
"bloodGroup": [
"AB+"
],
"mobileNumber": "text",
"altContactNumber": "text",
"email": "[email protected]",
"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]"
]
}
}
],
"fatherName": "text",
"husbandName": "text",
"relationship": "text",
"identifiers": [
{
"identifierType": "SYSTEM_GENERATED",
"identifierId": "ABCD-1212"
}
],
"skills": [
{
"type": "text",
"level": "text",
"experience": "text"
}
],
"photo": "text",
"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"
},
"Individual": {
"id": "text",
"individualId": "text",
"tenantId": "tenantA",
"clientReferenceId": "text",
"userId": "text",
"name": {
"givenName": "text",
"familyName": "text",
"otherNames": "text"
},
"dateOfBirth": "14/10/2022",
"gender": "MALE",
"bloodGroup": [
"AB+"
],
"mobileNumber": "text",
"altContactNumber": "text",
"email": "[email protected]",
"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"
}
}
],
"fatherName": "text",
"husbandName": "text",
"relationship": "text",
"identifiers": [
{
"identifierType": "SYSTEM_GENERATED",
"identifierId": "ABCD-1212"
}
],
"skills": [
{
"id": "text",
"type": "text",
"level": "text",
"experience": "text"
}
],
"photo": "text",
"additionalFields": {
"schema": "HOUSEHOLD",
"version": 2,
"fields": [
{
"key": "height",
"value": 180
}
]
},
"isDeleted": true,
"isSystemUser": true,
"rowVersion": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
}Soft delete the details of a existing Individual and nested entities in bulk
Query parameters
echoResourceanyOptional
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
Responses
202
Accepted
application/json
400
Bad Request
application/json
500
Internal Server Error
application/json
post
POST /individual/v1/bulk/_delete HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 1150
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"Individuals": [
{
"individualId": "text",
"tenantId": "tenantA",
"clientReferenceId": "text",
"name": {
"givenName": "text",
"familyName": "text",
"otherNames": "text"
},
"dateOfBirth": "14/10/2022",
"gender": "MALE",
"bloodGroup": [
"AB+"
],
"mobileNumber": "text",
"altContactNumber": "text",
"email": "[email protected]",
"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]"
}
}
],
"fatherName": "text",
"husbandName": "text",
"relationship": "text",
"identifiers": [
{
"identifierType": "SYSTEM_GENERATED",
"identifierId": "ABCD-1212"
}
],
"skills": [
{
"type": "text",
"level": "text",
"experience": "text"
}
],
"photo": "text",
"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 Individual
Query parameters
limitanyRequired
Pagination - limit records in response
offsetanyRequired
Pagination - offset from which records should be returned in response
tenantIdanyRequired
Unique id for a tenant.
lastChangedSinceanyOptional
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.
includeDeletedanyOptional
Used in search APIs to specify if (soft) deleted records should be included in search results.
Body
Responses
200
Ok
application/json
400
Bad Request
application/json
500
Internal Server Error
application/json
post
POST /individual/v1/_search?limit=null&offset=null&tenantId=null HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 534
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text"
},
"Individual": {
"individualId": "text",
"id": [
"text"
],
"clientReferenceId": [
"text"
],
"name": {
"givenName": "text",
"familyName": "text",
"otherNames": "text"
},
"dateOfBirth": "14/10/2022",
"gender": "MALE",
"mobileNumber": "text",
"socialCategory": "text",
"identifier": {
"identifierType": "SYSTEM_GENERATED",
"identifierId": "ABCD-1212"
},
"boundaryCode": "text",
"wardCode": "text",
"createdFrom": 1,
"createdTo": 1
}
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"resMsgId": "text",
"msgId": "text",
"status": "SUCCESSFUL"
},
"Individuals": [
{
"id": "text",
"individualId": "text",
"tenantId": "tenantA",
"clientReferenceId": "text",
"userId": "text",
"name": {
"givenName": "text",
"familyName": "text",
"otherNames": "text"
},
"dateOfBirth": "14/10/2022",
"gender": "MALE",
"bloodGroup": [
"AB+"
],
"mobileNumber": "text",
"altContactNumber": "text",
"email": "[email protected]",
"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"
}
}
],
"fatherName": "text",
"husbandName": "text",
"relationship": "text",
"identifiers": [
{
"identifierType": "SYSTEM_GENERATED",
"identifierId": "ABCD-1212"
}
],
"skills": [
{
"id": "text",
"type": "text",
"level": "text",
"experience": "text"
}
],
"photo": "text",
"additionalFields": {
"schema": "HOUSEHOLD",
"version": 2,
"fields": [
{
"key": "height",
"value": 180
}
]
},
"isDeleted": true,
"isSystemUser": true,
"rowVersion": 1,
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}Last updated
Was this helpful?