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

Description

Updates a Child data.

Permissions:

• Only Admin user can do this.

Scope

children:update

URL

PATCH https://localhost/v1/children/{child_id}

Parameters

child_id: string (A 24-byte hex ID)

Request body

{
  "username": "NEW_CHILD",
  "gender": "male",
  "age": 11,
  "institution_id": "5a62be07de34500146d9c624"
}

Curl example

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

Response body

• 200 Updated child data.

  {
    "id": "5db1cf6c099ed31587a74cf4",
    "username": "NEW_CHILD",
    "institution_id": "5a62be07de34500146d9c624",
    "gender": "male",
    "age": 11
  }
  

• 400 Validation errors

  • Invalid JSON format

  • Invalid child_id

  • Invalid institution_id

  • Unregistered institution

  • Empty field

    • 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

  • Invalid gender

    {
      "code": 400,
      "message": "One or more request fields are invalid...",
      "description": "The names of the allowed genders are: male, female."
    }
    

  • Invalid age

    {
      "code": 400,
      "message": "One or more request fields are invalid...",
      "description": "Provided age is not a valid number!" || "Age cannot be less than or equal to zero!"
    }
    

• 401 Unauthorized Error

• 403 Permission Error

• 404 Not Found Error

• 409 Conflict Error

• 429 Too Many Requests Error

• 500 Internal Server Error