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

Description

Updates a health professional data.

Permissions:

• Admin user can update information from any Health Professional.

• Health professionals users can update only their own information.

Scope

healthprofessionals:update

URL

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

Parameters

healthprofessional_id: string (A 24-byte hex ID)

Request body

    {
      "username": "healthprofessional01",
      "institution_id": "5a62be07de34500146d9c624"
    }

Curl example

curl -X PATCH "https://localhost/v1/healthprofessionals/5a62be07de34500146d9c544" -H "accept: application/json" -H "Authorization: Bearer YOUR_ACCESS_TOKEN" -H "Content-Type: application/json" -d "{"username":"new_hprof_username"}"

Response body

• 200 Updated health professional data.

  {
    "id": "5db2ef6bbec1431c51ae15f8",
    "username": "healthprofessional01",
    "institution_id": "5a62be07de34500146d9c624",
    "children_groups": [
      {
        "id": "5a11d7240f78690bf1d35ec1",
        "name": "Group One",
        "school_class": "4th Grade",
        "children": [
          {
            "id": "5a62be07de34500146d9c544",
            "username": "BR9999",
            "gender": "male",
            "age": 11,
            "institution_id": "5a62be07de34500146d9c624"
          }
        ]
      }
    ]
  }
  

• 400 Validation errors

  • Invalid JSON format

  • Invalid healthprofessional_id

  • Invalid institution_id

  • Unregistered institution

  • Empty string

    • Example

      {
        "code": 400,
        "message": "One or more request fields are invalid...",
        "description": "username must have at least one character!"
      }
      

  • Invalid string

    • Example

    {
      "code": 400,
      "message": "One or more request fields are invalid...",
      "description": "username must be a string!"
    }
    

  • There is an attempt to update the password

• 401 Unauthorized Error

• 403 Permission Error

• 404 Not Found Error

• 409 Conflict Error

• 429 Too Many Requests Error

• 500 Internal Server Error