POST families.children - ocariot/api-gateway GitHub Wiki

Description

Associates a child with a family by id.

Permissions:

• Only Admin user can do this.

Scope

families:create

URL

POST https://localhost/v1/families/{family_id}/children/{child_id}

Parameters

family_id: string (A 24-byte hex ID)
child_id: string (A 24-byte hex ID)

Curl example

curl -X POST "https://localhost/v1/families/5db202c1bbaa611e0b1d5e53/children/5db1f8f0bbaa611e0b1d5e52" -H "accept: application/json" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response body

• 200 Child associated sucessfully.

  {
    "id": "5db202c1bbaa611e0b1d5e53",
    "username": "family01",
    "institution_id": "5db05279fcfefe5c3de20497",
    "children": [
      {
        "id": "5db1cf65099ed31587a74cf3",
        "username": "BR0001",
        "institution_id": "5db05279fcfefe5c3de20497",
        "gender": "male",
        "age": 11
      },
      {
        "id": "5db1f8f0bbaa611e0b1d5e52",
        "username": "NEW_CHILD",
        "institution_id": "5db05279fcfefe5c3de20497",
        "gender": "male",
        "age": 12
      }
    ]
  }
  

• 400 Validation errors

  • Invalid family_id

  • Invalid child_id

  • The child is not registered

    {
      "code": 400,
      "message": "The association could not be performed because the child does not have a record."
    }
    

• 401 Unauthorized Error

• 403 Permission Error

• 404 Not Found Error

• 429 Too Many Requests Error

• 500 Internal Server Error