Welcome to Python UCS@school Kelvin REST API Client’s documentation!

Contents:

• Python UCS@school Kelvin REST API Client
  • Features
  • Compatibility
  • Usage
  • Installation
  • Tests
  • Logging
  • Repo permissions
  • Credits
• Installation
  • Stable release
  • From sources
• Usage
  • Authentication and authorization
  • Correlation ID
  • Language Header
    • Set Accept-Language header within a Session context
  • Resource Role
    • Kelvin API documentation
    • Role class
    • RoleResource class
    • Create role
    • Retrieve role
    • Check if role exists
    • Search roles
    • Change role properties
    • Move role
    • Delete role
  • Resource School
    • Kelvin API documentation
    • School class
    • SchoolResource class
    • Create school
    • Retrieve school
    • Check if school exists
    • Search schools
    • Change school properties
    • Move school
    • Delete school
  • Resource SchoolClass
    • SchoolClass class
    • SchoolClassResource class
    • Create school class
    • Retrieve school class
    • Check if school class exists
    • Search school classes
    • Change school class properties
    • Move school class
    • Delete school class
  • Resource Users
    • Kelvin API documentation
    • User class
    • UserResource class
    • Create user
    • Retrieve user
    • Check if user exists
    • Search users
    • Change user properties
    • Move user
    • Delete user
  • Resource WorkGroup
    • WorkGroup class
    • WorkGroupResource class
    • Create workgroup
    • Retrieve workgroup
    • Check if workgroup exists
    • Search workgroups
    • Change workgroup properties
    • Move workgroup
    • Delete workgroup
  • Note on moving of objects
• ucsschool.kelvin.client package
  • Submodules
    • ucsschool.kelvin.client.base module
    • ucsschool.kelvin.client.exceptions module
    • ucsschool.kelvin.client.role module
    • ucsschool.kelvin.client.school module
    • ucsschool.kelvin.client.school_class module
    • ucsschool.kelvin.client.session module
    • ucsschool.kelvin.client.user module
    • ucsschool.kelvin.client.workgroup module
  • Module contents
• Contributing
  • Types of Contributions
    • Report Bugs
    • Fix Bugs
    • Implement Features
    • Write Documentation
    • Submit Feedback
  • Get Started!
  • Pull Request Guidelines
  • Tips
  • Deploying
• History
  • 2.2.2 (2023-04-14)
  • 2.2.1 (2022-12-15)
  • 2.2.0 (2022-10-13)
  • 2.1.0 (2022-10-07)
  • 2.0.1 (2022-10-05)
  • 2.0.0 (2022-09-10)
  • 1.7.1 (2022-08-30)
  • 1.7.0 (2022-07-07)
  • 1.6.1 (2022-06-30)
  • 1.6.0 (2022-06-27)
  • 1.5.2.1 (2022-04-05)
  • 1.5.2 (2022-02-22)
  • 1.5.1 (2021-11-30)
  • 1.5.0 (2021-09-21)
  • 0.3.0 (2021-05-04)
  • 0.2.2 (2020-11-09)
  • 0.2.1 (2020-08-07)
  • 0.2.0 (2020-04-17)
  • 0.1.0 (2020-04-16)

Indices and tables

• Index
• Module Index
• Search Page