GET health professional children groups - ocariot/api-gateway GitHub Wiki

Description

Returns list with all groups of children associated with a Health Professional.

Permissions:

Only Health Professional users can list their own groups of children.

Scope

childrengroups:read

URL

GET https://localhost/v1/healthprofessionals/{healthprofessional_id}/children/groups

Parameters

healthprofessional_id: string (A 24-byte hex ID)

Curl example

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

Response body

200 Successful requisition.

[
  {
    "id": "5db31277bec1431c51ae15fa",
    "name": "Group One",
    "children": [
      {
        "id": "5db1f8f0bbaa611e0b1d5e52",
        "username": "BR0001",
        "institution_id": "5db05279fcfefe5c3de20497",
        "gender": "male",
        "age": 12
      },
      {
        "id": "5db1da62bbaa611e0b1d5e50",
        "username": "BR0002",
        "institution_id": "5db05279fcfefe5c3de20497",
        "gender": "male",
        "age": 11
      }
    ],
    "school_class": "4th Grade"
  }
]

400 Validation errors
- Invalid health professional id
401 Unauthorized Error
403 Permission 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.

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

https://localhost/v1/healthprofessionals/5a62be07de34500146d9c544/children/groups?name=*BR*&sort=name&page=1&limit=10

For more details about using Query Strings click here.