POST educator children group - ocariot/api-gateway GitHub Wiki

Description

Register a new children group, and associated it with an Educator.

Permissions:

• Only Educator user can create groups of children and for himself.

Scope

childrengroups:create

URL

POST https://localhost/v1/educators/{educator_id}/children/groups

Parameters

educator_id: string (A 24-byte hex ID)

Request body

{
  "name": "Group One",
  "children": [
    "5db1f8f0bbaa611e0b1d5e52", "5db1da62bbaa611e0b1d5e50"
  ],
  "school_class": "4th Grade"
}

Curl example

curl -X POST "https://localhost/v1/educators/5a62be07de34500146d9c544/children/groups" -H "accept: application/json" -H "Authorization: Bearer YOUR_ACCESS_TOKEN" -H "Content-Type: application/json" -d "{"name":"Group One","children":["5db1f8f0bbaa611e0b1d5e52","5db1da62bbaa611e0b1d5e50"],"school_class":"4th Grade"}"

Response body

• 201 Children group saved sucessfully and associated with educator.

  {
    "id": "5db31277bec1431c51ae15fa",
    "name": "Group One",
    "children": [
      {
        "id": "5db1f8f0bbaa611e0b1d5e52",
        "username": "BR0001",
        "institution_id": "5db05279fcfefe5c3de20497",
        "gender": "male",
        "age": 12
      },
      {
        "id": "5db1da62bbaa611e0b1d5e50",
        "username": "BR0002",
        "institution_id": "5db05279fcfefe5c3de20497",
        "gender": "male",
        "age": 11
      }
    ],
    "school_class": "4th Grade"
  }
  

• 400 Validation errors

  • Invalid JSON format

  • Invalid educator id

  • 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": "name, Collection with children IDs are required!"
    }
    

  • Empty string

    • Example

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

  • Invalid string

    • Example

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

• 401 Unauthorized Error

• 403 Permission Error

• 409 Conflict Error

• 429 Too Many Requests Error

• 500 Internal Server Error