PATCH institution by ID - ocariot/api-gateway GitHub Wiki

Description

Updates a institution data.

Permissions:

• Admin user can update data from any institution.
• Educator and Health Professional users can update data only from the institution to which they belong.

Scope

institutions:update

URL

PATCH https://localhost/v1/institutions/{institution_id}

Parameters

institution_id: string (A 24-byte hex ID)

Request body

{
  "type": "Institute of Scientific Research",
  "name": "NUTES/UEPB",
  "address": "Av. Juvêncio Arruda, S/N - Universitário, Campina Grande - PB, 58429-600",
  "latitude": "-7.2100766",
  "longitude": "-35.9175756"
}

Curl example

curl -X PATCH "https://localhost/v1/institutions/5a62be07de34500146d9c544" -H "accept: application/json" -H "Authorization: Bearer YOUR_ACCESS_TOKEN" -H "Content-Type: application/json" -d "{"name":"NUTES/UEPB"}"

Response body

• 200 Updated institution data.

  {
    "id": "5db32dcabec1431c51ae15fc",
    "type": "Institute of Scientific Research",
    "name": "NUTES/UEPB",
    "address": "Av. Juvêncio Arruda, S/N - Universitário, Campina Grande - PB, 58429-600",
    "latitude": "-7.2100766",
    "longitude": "-35.9175756"
  }
  

• 400 Validation errors

  • Invalid JSON format

  • Invalid institution id

  • Empty string

    • Example

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

  • Invalid string

    • Example

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

• 401 Unauthorized Error

• 403 Permission Error

• 404 Not Found Error

• 409 Conflict Error

• 429 Too Many Requests Error

• 500 Internal Server Error