APIs - data exchange
This integration is used to transfer Data from WebUntis to your 3rd-Party-Application or the other way.
We provide APIs which follows the international OneRoster specification and we provide our own WebUntis specific APIs.
OneRoster APIs
It´s based on REST-Interfaces that are correspondig to the international OneRoster-Specification 1.1 from IMS Global.
OneRoster 1.1 is a standard for sharing roster data between different systems at a school. Here you can find more informations about the Specification: OneRoster v1.1 Final Specification
The following APIs are provided by WebUntis:
|
Domain |
Service Call |
Endpoint |
|---|---|---|
|
Organisation |
getAllOrgs |
{{EAP_URL}}ims/oneroster/v1p1/orgs |
|
getOrg |
{{EAP_URL}}ims/oneroster/v1p1/orgs/{{id}} |
|
|
getAllSchools |
{{EAP_URL}}ims/oneroster/v1p1/schools |
|
|
getSchool |
{{EAP_URL}}ims/oneroster/v1p1/schools/{{id}} |
|
|
User |
getAllUsers |
{{EAP_URL}}ims/oneroster/v1p1/users |
|
getAllStudents |
{{EAP_URL}}ims/oneroster/v1p1/students/ |
|
|
getAllTeachers |
{{EAP_URL}}ims/oneroster/v1p1/teachers |
|
|
getTeachersForSchool |
{{EAP_URL}}ims/oneroster/v1p1/schools/{{id}}/teachers |
|
|
getStudentsForSchool |
{{EAP_URL}}ims/oneroster/v1p1/schools/{{id}}/students |
|
|
getStudent |
{{EAP_URL}}ims/oneroster/v1p1/students/{{id}} |
|
|
getTeacher |
{{EAP_URL}}ims/oneroster/v1p1/teachers/{{id}} |
|
|
getUser |
{{EAP_URL}}ims/oneroster/v1p1/users/{{id}} |
|
|
getStudentsForClassInSchool |
{{EAP_URL}}ims/oneroster/v1p1/classes/{{id}}/students |
|
|
getTeachersForClassInSchool |
{{EAP_URL}}ims/oneroster/v1p1/classes/{{id}}/teachers |
|
|
Class |
getAllClasses |
{{EAP_URL}}ims/oneroster/v1p1/classes |
|
|
getClass |
{{EAP_URL}}ims/oneroster/v1p1/classes/{{id}} |
For further informations about the API and how to call it, please check the OneRoster-Specification above.
Attention: A class in OneRoster is not a "Class" in WebUntis! A class in OneRoster is equivalent to a lesson in WebUntis.
Information:
We extend the following information using the metadata-attributes:
- User-information: Sex (gender) and the birthdate. Both attributes are optional.
- Class-information: ID and name of the WebUntis-Classes (eg. "1A")
WebUntis APIs
Managing student masterdata
With these APIs you can manage student masterdata including class-assignments and user for the student.
There is currently no way to delete students via the API. This needs to be done manually in WebUntis.
You can find the YAML-specification down below under "openapi-extern-student-management.yaml"
|
Domain |
Service Call |
Endpoint |
|---|---|---|
|
Student |
getStudent |
GET {{EAP_URL}}WebUntis/api/rest/extern/v1/students/{{id}} |
|
getStudents |
GET {{EAP_URL}}WebUntis/api/rest/extern/v1/students/ |
|
|
createStudents |
POST {{EAP_URL}}WebUntis/api/rest/extern/v1/students/ |
|
|
updateStudents |
PUT {{EAP_URL}}WebUntis/api/rest/extern/v1/students/ |
Reading up2date timetable
coming soon...