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

Description

Returns a unique health professional by id.

Permissions:

• Admin User can list information from any Health Professional.

• Health Professional users can list only their own information.

Scope

healthprofessionals:read

URL

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

Parameters

healthprofessional_id: string (A 24-byte hex ID)

Curl example

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

Response body

• 200 Successful requisition.

  {
    "id": "5a62be07de34500146d9c544",
    "username": "healthprofessional01",
    "institution_id": "5db05279fcfefe5c3de20497",
    "children_groups": [
      {
        "id": "5db065a5e59316737e2878a3",
        "name": "Group One",
        "children": [
          {
            "id": "5db05289fcfefe5c3de20498",
            "username": "BR0001",
            "institution_id": "5db05279fcfefe5c3de20497",
            "gender": "male",
            "age": 11
          }
        ],
        "school_class": "4th Grade"
      }
    ]
  }
  

• 400 Validation errors

  • Invalid healthprofessional_id

• 401 Unauthorized Error

• 403 Permission Error

• 404 Not Found Error

• 429 Too Many Requests Error

• 500 Internal Server Error