GET health professional children group by ID - ocariot/api-gateway GitHub Wiki

Description

Recover an unique children group associated with a Health Professional by id.

Permissions:

• Only Health Professional users can list data from their own group of children.

Scope

childrengroups:read

URL

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

Parameters

healthprofessional_id: string (A 24-byte hex ID)
group_id: string (A 24-byte hex ID)

Curl example

curl -X GET "https://localhost/v1/healthprofessionals/5a62be07de34500146d9c544/children/groups/5a62be07d6f33400146c9b61" -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
  • Invalid children group id

• 401 Unauthorized Error

• 403 Permission Error

• 404 Not Found Error

• 429 Too Many Requests Error

• 500 Internal Server Error