GET educator by ID

Description

Returns a unique educator by id.

Permissions:

• Admin user can list information of any Educator.

• Educators users can list only their own information.

Scope

educators:read

URL

GET https://localhost:3001/v1/educators/{educator_id}

Parameters

educator_id: string (A 24-byte hex ID)

Curl example

curl -X GET "https://localhost:3001/v1/educators/5a62be07de34500146d9c544" -H "accept: application/json"

Response body

• 200 Successful requisition.

  {
    "id": "5a62be07de34500146d9c544",
    "username": "educator01",
    "institution_id": "5db05279fcfefe5c3de20497",
    "children_groups": [
      {
        "id": "5db065a5e59316737e2878a3",
        "name": "Group One",
        "children": [
          {
            "id": "5db05289fcfefe5c3de20498",
            "username": "BR0001",
            "institution_id": "5db05279fcfefe5c3de20497",
            "gender": "male",
            "age": 11
          }
        ],
        "school_class": "4th Grade"
      }
    ]
  }

• 400 Validation errors

  • Invalid educator_id

• 404 Not Found Error

• 500 Internal Server Error