Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

  • Beneficiary is the back-end term for what in the front-end is called a Contact

  • The page displayed screenshot below is a typical Contact Profile Page on Makerble for a contact called Abigail Holmes

  • The red section is her Bio. It contains

    • Default fields: Name, profile picture, address, date of birth

    • Unlimited custom fields, e.g. Marital status etc.

  • The purple section is her Timeline. It contains stories that she is tagged in.

...

Beneficiaries (aka contacts)

Desc: Get all viewable contact details

Latest changes: now includes avatar and custom fields

url: /beneficiaries

params: default params

...

response example: default response example (multiple records)

 

Desc: Get a single contact

Latest changes: now includes avatar and custom fields

url: /beneficiaries/:id

response example: default response example (single record)

 

Desc: Post a single contact

url: /beneficiaries

method: POST

...

body:{ "beneficiary": { "name": "Jack", "date_of_birth": "13-05-1899", "address": "Paris", "latitude": "48.856613", "longitude": "2.352222", "beneficiary_type_id": 1, "owner_id": 237 }, "project_ids": [572], "custom_fields": [ {"173": "3256895684"}], "beneficiary_category_ids": [294] }

...

response example: default response example (single record)

 

Desc: Get all advanced custom fields

url: beneficiaries/advanced_custom_fields

...

response example: default response example (multiple records)

 

Desc: Get all impact box data

url: /beneficiaries/impact_box_data

...

response example: default response example (multiple records)

...

Walkthrough an example

This article provides an example of the calls to make to the Makerble API and the responses you can expect back

...

Documentation

  • Beneficiaries are called Contacts in the front-end