https://github.com/mrousavy/webuntissharp
:alarm_clock: A Wrapper of the WebUntis JSON API for .NET
https://github.com/mrousavy/webuntissharp
api csharp json net untis webuntis wrapper
Last synced: about 2 months ago
JSON representation
:alarm_clock: A Wrapper of the WebUntis JSON API for .NET
- Host: GitHub
- URL: https://github.com/mrousavy/webuntissharp
- Owner: mrousavy
- License: mit
- Created: 2017-02-16T15:40:36.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-24T19:26:29.000Z (about 7 years ago)
- Last Synced: 2025-03-17T02:47:38.757Z (3 months ago)
- Topics: api, csharp, json, net, untis, webuntis, wrapper
- Language: C#
- Homepage:
- Size: 1.76 MB
- Stars: 14
- Watchers: 5
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
WebUntisSharp
A Wrapper of the WebUntis JSON API for .NET for sending and receiving Untis Informations
# How to use
## Full guide
Take a look at the [wiki](https://github.com/mrousavy/WebUntisSharp/wiki) to see the full documentation for this API.
## Quickstart
### 1. Add Binaries
+ NuGet
* [WebUntisSharp is also available on NuGet!](https://www.nuget.org/packages/WebUntisSharp) Install by typing `Install-Package WebUntisSharp` in NuGet Package Manager Console. (Or search for `WebUntisSharp` on NuGet)
+ Manually
1. [Download the latest Library (.dll)](https://github.com/mrousavy/WebUntisSharp/releases/download/1.0.0.3/WebUntisSharp.dll)
2. Add the .dll to your Project (Right click `References` in the Project Tree View, click `Add References` and `Browse` to the `.dll` File)
### 2. Create WebUntis Object
* C#:
```C#
WebUntis untis = new WebUntis("mrousavy", "password1234", schoolUrl, "WebUntisSharp API");
```
* VB:
```VB
Dim untis As new WebUntis("mrousavy", "password1234", schoolUrl, "WebUntisSharp API")
```
### 3. Send Requests
* C#:
```C#
var timegrid = await untis.GetTimegrid();
```
* VB:
```VB
Dim timegrid As Timegrid = Await untis.GetTimegrid()
```
### 4. Logout
* Logout Method
* C#:
```C#
untis.Logout();
```
* VB:
```VB
untis.Logout()
```
* using Statement
* C#:
```C#
using(WebUntis untis = new WebUntis("mrousavy", "password1234", schoolUrl, "WebUntisSharp API"))
// our Requests to the WebUntis API go here
}
// WebUntis Object is now disposed and Logged out (Session has ended)
```
* VB:
```VB
Using untis As New WebUntis("mrousavy", "password1234", schoolUrl, "WebUntisSharp API")
' Your Requests to the WebUntis API go here
End Using
' WebUntis Object is now disposed and Logged out (Session has ended)
```