UCS@school Kelvin REST API Update

Using the UCS@school Kelvin REST API app, you can conveniently create, delete or modify UCS@school user and class objects via a REST interface. Unlike the import function and manual interventions via the web interface, it is less error-prone and can be addressed automatically.

Important Changes in Version 1.7.0:

  • School classes and workgroups can now be created without share. Until now, group shares were a prerequisite for creating a class or workgroup. By joining a group with share, students and teachers can share data that is of interest to the respective group, such as worksheets. However, since this does not always go hand in hand in practice, sharing is now optional during creation and thus more data-efficient.
  • If you want to check if a school already exists before creating it, the new HEAD endpoint for schools now makes it easier to find out.

UCS@school REST API

  • Creating or modifying users with workgroups is now also supported by the API. Other than school classes, the groups are not created implicitly and need to be created separately.

User attributes Rest API

  • We have also adjusted the update process so that project-specific configuration values (UCR variables) previously set in the app’s Docker container remain persistent during an update.
  • A correlation ID can be included in requests against the API, which is then also passed on to other UCS APIs in the processing process. This makes it easier to track requests in log files and locate problem cases. Please find a description of how to do this with the Python client here: https://kelvin-rest-api-client.readthedocs.io/en/latest/usage-correlation.html.

Important note: If the API you are using is accessed via the UCS@school Kelvin REST API Python client, please check that all Python clients are updated to at least version 1.7.0 before updating your app. This will ensure that all queries can be processed. The version history is described here: https://kelvin-rest-api-client.readthedocs.io/en/latest/history.html.

See the UCS@school Kelvin REST API documentation for a listing of breaking changes that you need to be aware of.

If you have any suggestions or would like to give us feedback on our documentation, please do not hesitate to contact us. Simply click on the speech bubble next to the headings. This way we will see immediately which section you are referring to.

Before updating the app, please carefully read the changelog.

Use UCS Core Edition for Free!

Download now
Tobias Wenzel

Tobias Wenzel has been working as an Open Source Software Engineer in the UCS@school team at Univention in Leipzig since January 2020.

What's your opinion? Leave a comment!

Your email address will not be published.