Introduction

• Every Beneficiary Category is assigned to one or more Beneficiary Types (these are called Contact Types in the front-end and Beneficiary Types in the back-end)

• There are currently four types of Beneficiary that can be created:

  • Person

  • Organisation

  • Animal

  • Object

• Whenever a beneficiary is created using the API, you will need to state which type of beneficiary is being created

API Documentation

Beneficiary Types Category (Beneficiary Category and Beneficiary Types join table)

Desc: Get all beneficiary types categories

url: /beneficiary_types_categories

params: default params

response example: default response example (multiple records)

Documentation

• Endpoint: POST /api/v2/beneficiary_types

• Header: Token and Email
  

  

• Request Body Format: none

• Body : none

• Response Format: JSON

• Response Attributes

  • id (integer): The unique identifier.

  • name (string): Beneficiary Type name

  • updated_At (string): Last Updated

  • created_At (string) : Created At
    

Example Respone :

{
    "page": 1,
    "page_size": 4,
    "page_count": 1,
    "total_count": 4,
    "data": [
        {
            "id": 1,
            "name": "Person",
            "updated_at": "2020-09-28T15:19:24.310+01:00",
            "created_at": "2020-09-28T15:19:24.310+01:00"
        },
        {
            "id": 2,
            "name": "Object",
            "updated_at": "2020-09-28T15:19:24.319+01:00",
            "created_at": "2020-09-28T15:19:24.319+01:00"
        },
        {
            "id": 3,
            "name": "Organisation",
            "updated_at": "2020-09-28T15:19:24.324+01:00",
            "created_at": "2020-09-28T15:19:24.324+01:00"
        },
        {
            "id": 4,
            "name": "Animal",
            "updated_at": "2021-09-11T10:04:59.074+01:00",
            "created_at": "2021-09-11T10:04:59.074+01:00"
        }
    ]
}

Postman API Screenshot :