POST educators - ocariot/api-gateway GitHub Wiki

Description

Register a new educator.

Permissions:

• Only Admin user can do this.

Scope

educators:create

URL

POST https://localhost/v1/educators

Request body

{
  "username": "educator01",
  "password": "mys3cr3tp4ss",
  "institution_id": "5a62be07de34500146d9c624"
}

Curl example

curl -X POST "https://localhost/v1/educators" -H "accept: application/json" -H "Authorization: Bearer YOUR_ACCESS_TOKEN" -H "Content-Type: application/json" -d "{"username":"educator01","password":"mys3cr3tp4ss","institution_id":"5a62be07de34500146d9c624"}"

Response body

• 201 Educator saved sucessfully.

  {
    "id": "5db2ef6bbec1431c51ae15f8",
    "username": "educator01",
    "institution_id": "5a62be07de34500146d9c624",
    "children_groups": []
  }
  

• 400 Validation errors

  • Invalid JSON format

  • Invalid institution id

  • Unregistered institution

  • Missing fields

    • Example

    {
      "code": 400,
      "message": "Required fields were not provided...",
      "description": "username, password, institution 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