Giter Club home page Giter Club logo

webuntisnet's Introduction

WebUntisNet

This is an API client to access Webuntis. It is written as .NET Standard library to be used in .NET Framework projects and .NET Core projects as well.

Status

Build status NuGet

Usage

Connect to your WebUntis instance

WebUntisClient is the main entry point for you to use this library. The constructor needs several parameters which are mandantory to connect to your WebUntis instance. You don't have to deal with authentication and session handling. It's all done by this library.

using(var client = new WebUntisClient("https://my.webuntis.local/WebUntis/jsonrpc.do", "schoolname", "user", "password"))
{
    var timetable = await client.GetTimetableAsync(ElementType.Student, 1497);
    ....
}

Supported functions

  • GetTeachersAsync (Ref. 3)
  • GetStudentsAsync (Ref. 4)
  • GetClassesAsync (Ref. 5)
  • GetSubjectsAsync (Ref. 6)
  • GetRoomsAsync (Ref. 7)
  • GetDepartmentsAsync (Ref. 8)
  • GetHolidaysAsync (Ref. 9)
  • GetTimegridAsync (Ref. 10)
  • GetStatusDataAsync (Ref. 11)
  • GetCurrentSchoolYearAsync (Ref. 12)
  • GetSchoolYearsAsync (Ref. 13)
  • GetTimetableAsync (Ref. 14)
  • GetLatestImportTimeAsync (Ref. 17)
  • GetPersonIdAsync (Ref. 18)
  • GetClassRegEvents (Ref. 20)
  • GetExamsAsync (Ref. 21)
  • GetExamTypesAsync (Ref. 22, not tested)

Functions under development

  • Request timetable for an element (customizable) (Ref. 15)
  • Request substitutions (Ref. 19)

Contribution

As Untis provides minimal support for it's API and the quality of their API documentation is not as good as it could be, I'd be happy to find someone to contribute or to provide a demo access to WebUntis. I tested the calls using the official instance, but the public users don't have suficcient rights for all actions.

webuntisnet's People

Contributors

martinhey avatar

Watchers

 avatar

webuntisnet's Issues

implement customizable timetable request

15 in doc contains "request timetable for an element (customizable)"

this request allows to include detail information - so you don't have to make subsequent calls to decode the ids

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.