PATCH educator by ID - ocariot/api-gateway GitHub Wiki
Description
Updates an educator data.
Permissions:
-
Admin user can update information of any Educator.
-
Educators users can update only their own information.
Scope
educators:update
URL
Parameters
educator_id: string (A 24-byte hex ID)
Request body
{
"username": "educator01",
"institution_id": "5a62be07de34500146d9c624"
}
Curl example
curl -X PATCH "https://localhost/v1/educators/5a62be07de34500146d9c544" -H "accept: application/json" -H "Authorization: Bearer YOUR_ACCESS_TOKEN" -H "Content-Type: application/json" -d "{"username":"new_edu_username"}"
Response body
-
200
Updated educator data.{ "id": "5db2ef6bbec1431c51ae15f8", "username": "educator01", "institution_id": "5a62be07de34500146d9c624", "children_groups": [ { "id": "5a11d7240f78690bf1d35ec1", "name": "Group One", "school_class": "4th Grade", "children": [ { "id": "5a62be07de34500146d9c544", "username": "BR9999", "gender": "male", "age": 11, "institution_id": "5a62be07de34500146d9c624" } ] } ] }
-
400
Validation errors-
- Example
{ "code": 400, "message": "One or more request fields are invalid...", "description": "username must have at least one character!" }
- Example
-
- Example
{ "code": 400, "message": "One or more request fields are invalid...", "description": "username must be a string!" }
-
403
Permission Error -
404
Not Found Error -
409
Conflict Error