GET families.children

Description

Returns a list with children associated with a family.

Permissions:

• Admin user can list information of any Child user.

• Family user can list only their own children.

Scope

families:read

URL

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

Parameters

family_id: string (A 24-byte hex ID)

Curl example

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

Response body

• 200 Successful requisition.

  [
    {
      "id": "5db1cf65099ed31587a74cf3",
      "username": "BR0001",
      "institution_id": "5db05279fcfefe5c3de20497",
      "gender": "male",
      "age": 11
    },
    {
      "id": "5db1da62bbaa611e0b1d5e50",
      "username": "BR0002",
      "institution_id": "5db05279fcfefe5c3de20497",
      "gender": "male",
      "age": 11
    }
  ]

• 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

Query Strings (Optional)

Query strings are used as follows: there must be a question mark following the URL and providing the parameters for the desired operations. There are four possible operations: filtering, paging, limiting, and sorting.

• Filtering

  https://localhost/v1/families/5a62be07de34500146d9c544/children?username=*BR*

• Pagination

  https://localhost/v1/families/5a62be07de34500146d9c544/children?page=1

• Limitation

  https://localhost/v1/families/5a62be07de34500146d9c544/children?limit=100

• Sorting

  https://localhost/v1/families/5a62be07de34500146d9c544/children?sort=username,age

All parameters can also be used together concatenated by the & character as follows:

https://localhost/v1/families/5a62be07de34500146d9c544/children?username=*BR*&sort=username,age&page=1&limit=100

For more details about using Query Strings click here.