-
Notifications
You must be signed in to change notification settings - Fork 1
GET educators
JeffMedeiros edited this page Dec 2, 2019
·
5 revisions
Returns a list with educators.
Permissions:
- Only Admin user can list information of all educators.
educators:readAll
curl -X GET "https://localhost:3001/v1/educators" -H "accept: application/json"
-
200
Successful requisition.[ { "id": "5db06595e59316737e2878a2", "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" } ] } ]
Query strings are used as follows: there must be a question mark following the URL and providing the parameters for the desired operations. There are four possible operations: filtering, paging, limiting, and sorting.
-
Filtering
-
Pagination
-
Limitation
-
Sorting
All parameters can also be used together concatenated by the &
character as follows:
https://localhost:3001/v1/educators?username=*BR*&sort=username&page=1&limit=10
For more details about using Query Strings click here.
OCARIoT Account Microservice API (Full documentation)
- POST institutions
- GET institutions
- GET institutions.inst_id
- PATCH institutions.inst_id
- DELETE institutions.inst_id
- POST educators.children.groups
- GET educators.children.groups
- GET educators.children.groups.group_id
- PATCH educators.children.groups.group_id
- DELETE educators.children.groups.group_id
- POST healthprofessionals
- GET healthprofessionals
- GET healthprofessionals.hprof_id
- PATCH healthprofessionals.hprof_id