family_management

Get Relationship Types

Lists the relationship types an address can be assigned under, each with the id assign takes.

GET/api/family-management/get-relationship-types

Authorizations

Authorizationbearer tokenRequired

The access token from POST /api/hiecm/gateway/v3/sessions.

Responses

200

Example values, scrubbed.

500

Example values, scrubbed.

Error codes for this module

Get Relationship Types

curl --request GET \
  --url https://phrsbx.abdm.gov.in/api/family-management/get-relationship-types \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>'

[
  {
    "id": 3,
    "typeName": "Self"
  },
  {
    "id": 6,
    "typeName": "Father"
  },
  {
    "id": 7,
    "typeName": "Son"
  },
  {
    "id": 8,
    "typeName": "Daughter"
  },
  {
    "id": 9,
    "typeName": "Husband"
  },
  {
    "id": 10,
    "typeName": "Wife"
  },
  {
    "id": 11,
    "typeName": "Brother"
  },
  {
    "id": 12,
    "typeName": "Sister"
  },
  {
    "id": 13,
    "typeName": "Others"
  },
  {
    "id": 14,
    "typeName": "Father in law"
  },
  {
    "id": 15,
    "typeName": "Mother in law"
  },
  {
    "id": 16,
    "typeName": "Guardian"
  },
  {
    "id": 17,
    "typeName": "Grandmother"
  },
  {
    "id": 18,
    "typeName": "Grandfather"
  },
  {
    "id": 4,
    "typeName": "Mother"
  }
]

Generated from the schema. The values are placeholders, not a captured response.