POST families - ocariot/api-gateway GitHub Wiki

Description

Register a new family.

Permissions:

• Only Admin users can do this.

Scope

families:create

URL

POST https://localhost/v1/families

Request body

{
  "username": "family01",
  "password": "mys3cr3tp4ss",
    "children": [
        "5a62be07de34500146d9c544", "5a70be07de34500146d9c380"
    ],
  "institution_id": "5a62be07de34500146d9c624"
}

Curl example

curl -X POST "https://localhost/v1/families" -H "accept: application/json" -H "Authorization: Bearer YOUR_ACCESS_TOKEN" -H "Content-Type: application/json" -d "{"username":"family01","password":"mys3cr3tp4ss","children":["5a62be07de34500146d9c544","5a70be07de34500146d9c380"],"institution_id":"5a62be07de34500146d9c624"}"

Response body

• 201 Family saved sucessfully.

  {
    "id": "5db202c1bbaa611e0b1d5e53",
    "username": "family01",
    "institution_id": "5a62be07de34500146d9c624",
    "children": [
      {
        "id": "5a62be07de34500146d9c544",
        "username": "BR0001",
        "institution_id": "5a62be07de34500146d9c624",
        "gender": "female",
        "age": 7
      },
      {
        "id": "5a70be07de34500146d9c380",
        "username": "BR0002",
        "institution_id": "5a62be07de34500146d9c624",
        "gender": "male",
        "age": 11
      }
    ]
  }
  

• 400 Validation errors

  • Invalid JSON format

  • Invalid institution id

  • Unregistered institution

  • Invalid value of children

  • Some ids of children set to null or undefined

  • Unregistered children

    • Example

      {
        "code": 400,
        "message": "It is necessary for children to be registered before proceeding.",
        "description": "The following IDs were verified without registration: 5db05279fcfefe5c3de20497, 5a62be07de34500146d9c544"
      }
      

  • When there is at least one empty id in the children attribute

  • When there is at least one invalid id in the children attribute

    • Example

      {
        "code": 400,
        "message": "One or more request fields are invalid...",
        "description": "The following IDs from children attribute are not in valid format: 5a62be07de34500146d9c5434, 5db05279fcfefe5c3de204971"
      }
      

  • Missing fields

    • Example

    {
      "code": 400,
      "message": "Required fields were not provided...",
      "description": "username, password, institution, Collection with children IDs are required!"
    }
    

  • 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!"
    }
    

• 401 Unauthorized Error

• 403 Permission Error

• 409 Conflict Error

• 429 Too Many Requests Error

• 500 Internal Server Error