Individual

Individual Registry

Maintain and manage individual registries.

Create/Add a new Individual

Create a new Individual

POST/individual/v1/_create

Query parameters

Body

application/json

Capture details of Individual.

Individual*Individual (object)

A representation of an Individual.

Response

202400500

Accepted

Body

*/*

IndividualIndividual (object)

A representation of an Individual.

Request

JavaScriptCurl

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

Response

{
  "Individual": {
    "individualId": "text",
    "name": {
      "givenName": "text",
      "familyName": "text",
      "otherNames": "text"
    },
    "bloodGroup": "text",
    "mobileNumber": "text",
    "altContactNumber": "text",
    "email": "[e-mail]",
    "address": [],
    "fatherName": "text",
    "husbandName": "text",
    "relationship": "text",
    "identifiers": [
      {
        "identifierType": "SYSTEM_GENERATED",
        "identifierId": "ABCD-1212"
      }
    ],
    "skills": [
      {
        "type": "text",
        "level": "text",
        "experience": "text"
      }
    ],
    "photo": "text",
    "isSystemUser": false
  }
}

Create/Add Individuals

Create a new Individuals

POST/individual/v1/bulk/_create

Query parameters

Body

application/json

Capture details of Individual.

Individualsarray of Individual (object)

Response

202400500

Accepted

Body

*/*

IndividualBulkResponse (object)

Request

JavaScriptCurl

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

Response

{}

Update the details of a existing Individual

Update the details of a existing Individual

POST/individual/v1/_update

Query parameters

Body

application/json

Details for the Individual.

Individual*Individual (object)

A representation of an Individual.

Response

202400500

Accepted

Body

*/*

IndividualIndividual (object)

A representation of an Individual.

Request

JavaScriptCurl

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

Response

{
  "Individual": {
    "individualId": "text",
    "name": {
      "givenName": "text",
      "familyName": "text",
      "otherNames": "text"
    },
    "bloodGroup": "text",
    "mobileNumber": "text",
    "altContactNumber": "text",
    "email": "[e-mail]",
    "address": [],
    "fatherName": "text",
    "husbandName": "text",
    "relationship": "text",
    "identifiers": [
      {
        "identifierType": "SYSTEM_GENERATED",
        "identifierId": "ABCD-1212"
      }
    ],
    "skills": [
      {
        "type": "text",
        "level": "text",
        "experience": "text"
      }
    ],
    "photo": "text",
    "isSystemUser": false
  }
}

Update the details of existing Individuals

Update the details of existing Individuals

POST/individual/v1/bulk/_update

Query parameters

Body

application/json

Details for the Individual.

Individualsarray of Individual (object)

Response

202400500

Accepted

Body

*/*

IndividualBulkResponse (object)

Request

JavaScriptCurl

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

Response

{}

Soft delete the details of a existing Individual and nested entities

Soft delete the details of a existing Individual and nested entities

POST/individual/v1/_delete

Query parameters

Body

application/json

Details for the Individual.

Individual*Individual (object)

A representation of an Individual.

Response

202400500

Accepted

Body

*/*

IndividualIndividual (object)

A representation of an Individual.

Request

JavaScriptCurl

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

Response

{
  "Individual": {
    "individualId": "text",
    "name": {
      "givenName": "text",
      "familyName": "text",
      "otherNames": "text"
    },
    "bloodGroup": "text",
    "mobileNumber": "text",
    "altContactNumber": "text",
    "email": "[e-mail]",
    "address": [],
    "fatherName": "text",
    "husbandName": "text",
    "relationship": "text",
    "identifiers": [
      {
        "identifierType": "SYSTEM_GENERATED",
        "identifierId": "ABCD-1212"
      }
    ],
    "skills": [
      {
        "type": "text",
        "level": "text",
        "experience": "text"
      }
    ],
    "photo": "text",
    "isSystemUser": false
  }
}

Soft delete the details of a existing Individual and nested entities in bulk

Soft delete the details of a existing Individual and nested entities in bulk

POST/individual/v1/bulk/_delete

Query parameters

Body

application/json

Details for the Individual.

Individualsarray of Individual (object)

Response

202400500

Accepted

Body

*/*

IndividualBulkResponse (object)

Request

JavaScriptCurl

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

Response

{}

Search existing Individual

Search existing Individual

POST/individual/v1/_search

Query parameters

Body

application/json

Individual details.

Individual*IndividualSearch (object)

A representation of an Individual.

Response

200400500

Ok

Body

*/*

Individualsarray of Individual (object)

Request

JavaScriptCurl

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

Response

{
  "Individuals": [
    {
      "individualId": "text",
      "name": {
        "givenName": "text",
        "familyName": "text",
        "otherNames": "text"
      },
      "bloodGroup": "text",
      "mobileNumber": "text",
      "altContactNumber": "text",
      "email": "[e-mail]",
      "address": [],
      "fatherName": "text",
      "husbandName": "text",
      "relationship": "text",
      "identifiers": [
        {
          "identifierType": "SYSTEM_GENERATED",
          "identifierId": "ABCD-1212"
        }
      ],
      "skills": [
        {
          "type": "text",
          "level": "text",
          "experience": "text"
        }
      ],
      "photo": "text",
      "isSystemUser": false
    }
  ]
}