GET family by ID - ocariot/api-gateway GitHub Wiki

Description

Returns a unique family by id.

Permissions:

• Admin User can list information of any Family user.

• Families users can list only their own information.

Scope

families:read

URL

GET https://localhost/v1/families/{family_id}

Parameters

family_id: string (A 24-byte hex ID)

Curl example

curl -X GET "https://localhost/v1/families/5a62be07de34500146d9c544" -H "accept: application/json" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response body

• 200 Successful requisition.

  {
    "id": "5a62be07de34500146d9c544",
    "username": "family01",
    "children": [
      {
        "id": "5db05279fcfefe5c3de20497",
        "username": "BR9999",
        "gender": "male",
        "age": 11,
        "institution_id": "5a62be07de34500146d9c624"
      }
    ],
    "institution_id": "5a62be07de34500146d9c624"
  }
  

• 400 Validation errors

  • Invalid family_id

• 401 Unauthorized Error

• 403 Permission Error

• 404 Not Found Error

• 429 Too Many Requests Error

• 500 Internal Server Error