Tom hat dich am September 11, 2018 at 06:59PM gehated

It is possible to add the message center?

WebUntis/api/rest/view/v1/messages -> get all inbox messages

Tom hat dich am October 25, 2018 at 08:42PM gehated

The .getAbsentLesson() method currently wants a number as start- and endDate, but throws an error, because it actually wants a Date object. These kinds of issues, would occur no more if #80 would be implemented (migrating the project to typescript).

I can't find any solution for that. Is there one? If so how would i achieve this?

The website tell that the page is not there

This should be fairly straight forward as the library only consists of one actual file.
Many devs would benefit from this (e.g. ESModule syntax, types that 100% align, extending the classes is easier, etc.).

Just updated to v2 and well, it apparently doesnt like the server anymore:

Error: Failed to login. Server didn't return a session id.
    at WebUntisQR._otpLogin (/home/container/node_modules/webuntis/dist/webuntis.js:648:13)
    at processTicksAndRejections (node:internal/process/task_queues:96:5)
    at async WebUntisQR.login (/home/container/node_modules/webuntis/dist/webuntis.js:748:12)

Caused by (compiled) L648:

if (response.headers && response.headers["set-cookie"] && this._getCookieFromSetCookie(response.headers["set-cookie"]))
      throw new Error("Failed to login. Server didn't return a session id.");

But the last check in the if clause doesnt make sense, it should have a ! in front of it - esp as the next line uses it:

const sessionId = this._getCookieFromSetCookie(response.headers["set-cookie"]);

Added the ! in my code and its working completely fine then 🤷

Uncompiled:

In the documentation I could not find a function that returns exams. Python equivalent
Is there a way to parse this information otherwise or did I miss something?

Tom hat dich am September 11, 2018 at 06:58PM gehated

Hello, I need a function for converting a untis date into js date object.

Hello,
I'm trying to make an API call to get information on whether a student was present on a specific day.
I am successfully calling

the WebUntis API endpoint
GET {{EAP_URL}}WebUntis/api/rest/extern/v1/students/{{id}}
and the OneRoster WebUntis API endpoints (with two different sets of credentials (for the iServ/Moodle integration in the section platform))

I'm trying to make an API call to this endpoint
GET {{EAP_URL}}WebUntis/api/rest/extern/v1/timetable
But I'm getting Error 403 "Access is denied".

Can any of you guys tell me how to make that call work?
Do I need to set up a different set of credentials with the the correct permissions? (if yes, how?)

Or is there a different endpoint that I can call to get the data needed?

Thank you!

Currently, there are no tests for the package.

We should at least add some basic tests.

Hi, do you know anything about videoCalls?

My shool is starting to use that feature, but I cant get it via API..

On the Web, the information is sent via the data-request.

May I ask in the community forum for help?

"videoCall": {
                                "videoCallUrl": "abc.de or message",
                                "active": true
                            },

Tom hat dich am August 28, 2018 at 01:48PM gehated

Currently, github actions are failing. Example: https://github.com/SchoolUtils/WebUntis/actions/runs/3291404241/jobs/5425511477

Is there a way to check if a lesson on a specific date is cancelled?

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

If I type export SCHOOL=SZ II Utbremen, it raises Error: Failed to login. {"jsonrpc":"2.0","id":"error","error":{"message":"invalid schoolname","code":-8500}}.
But if I type export SCHOOL=SZ+II+Utbremen, the error is gone.

Tom hat dich am December 22, 2018 at 04:30PM gehated

Tom hat dich am October 28, 2018 at 04:40AM gehated

I sometimes get this error and was wondering what could cause it, as webuntis itself seems to be always available.
Can I just try to repeat the request, or should I wait a few minutes before trying again?

Full error:

Error: Server didn't return any result.
    at WebUntisQR._request (/home/container/node_modules/webuntis/index.js:745:42)
    at async WebUntisQR.getOwnClassTimetableForRange (/home/container/node_modules/webuntis/index.js:438:16)```

I am trying to use the WebUntis API in a React Native / TypeScript project on Stackblitz, but it keeps throwing this network error and I have no clue why.

I don't know if this has to do with the API, because I am new to react and APIs, so any help would be appreciated.

It's funny, because on the web untis page I can see my teachers, but on the mobile app i can't. Could it be that webuntis fetch the data an other way like the mobile app? And the mobile app use the offfical api?

Originally posted by @luwol03 in #29 (comment)

I am now in another class at the same school and still have the problem? Is there any way to fix this? Could we put there another function in the api wrapper that uses the route, the webui or app uses? Or should I extend that myself locally as this doesn't affect everyone?

EDIT:

Endpoint

GET https://neilo.webuntis.com/WebUntis/api/public/timetable/weekly/data?elementType=<elementType>&elementId=<elementId>&date=<date>&formatId=<formatId>

With the following parameters

{
  "data": {
    "result": {
      "data": {
        "noDetails": false,
        "elementIds": [343],
        "elementPeriods": {
          "343": [
            // Normal lesson
            {
              "id": 54533,
              "lessonId": 56456,
              "lessonNumber": 34532,
              "lessonCode": "LESSON",
              "lessonText": "This lesson is very cool",
              "periodText": "",
              "hasPeriodText": false,
              "periodInfo": "",
              "periodAttachments": [],
              "staffText": "",
              "staffAttachments": [],
              "substText": "",
              "date": 20220311,
              "startTime": 800,
              "endTime": 845,
              "elements": [
                {
                  "type": 1,
                  "id": 343,
                  "orgId": 0,
                  "missing": false,
                  "state": "REGULAR"
                },
                {
                  "type": 2,
                  "id": 643,
                  "orgId": 0,
                  "missing": false,
                  "state": "REGULAR"
                }
              ],
              "studentGroup": "SG",
              "hasInfo": false,
              "code": 0,
              "cellState": "STANDARD",
              "priority": 5,
              "is": {
                "standard": true,
                "event": false
              },
              "roomCapacity": 0,
              "studentCount": 0
            },

            // lesson with absent teacher
            {
              "id": 43543,
              "lessonId": 564324,
              "lessonNumber": 45343,
              "lessonCode": "LESSON",
              "lessonText": "",
              "periodText": "eigenst. Arbeiten",
              "hasPeriodText": true,
              "periodInfo": "",
              "periodAttachments": [],
              "staffText": "",
              "staffAttachments": [],
              "substText": "eigenst. Arbeiten",
              "date": 20220318,
              "startTime": 1000,
              "endTime": 1045,
              "elements": [
                  {
                      "type": 1,
                      "id": 343,
                      "orgId": 0,
                      "missing": false,
                      "state": "REGULAR"
                  },
                  {
                      "type": 2,
                      "id": 0,
                      "orgId": 544,
                      "missing": false,
                      "state": "ABSENT"
                  },
                  {
                      "type": 3,
                      "id": 435,
                      "orgId": 0,
                      "missing": false,
                      "state": "REGULAR"
                  },
                  {
                      "type": 4,
                      "id": 434,
                      "orgId": 0,
                      "missing": false,
                      "state": "REGULAR"
                  }
              ],
              "studentGroup": "h1_CK",
              "hasInfo": true,
              "code": 0,
              "cellState": "SUBSTITUTION", // "cellState": "ROOMSUBSTITUTION",
              "priority": 3,
              "is": {
                  // "roomSubstitution": true,
                  "substitution": true,
                  "event": false
              },
              "roomCapacity": 0,
              "studentCount": 0
            }
          ]
        },
        "elements": [
          // all different element types which are associated in the elementPeriods section
          // below is an example for each one. In real this responded with about 200
          // different elements with different ids. I just cutted all out to minimize the response

          // Class
          {
            "type": 1,
            "id": 343,
            "name": "MCK",
            "longName": "Meine Coole Klasse",
            "displayname": "MCK",
            "alternatename": "",
            "canViewTimetable": true,
            "roomCapacity": 0
          },

          // Teacher
          {
            "type": 2,
            "id": 643,
            "name": "Fs",
            "canViewTimetable": false,
            "externKey": "",
            "roomCapacity": 0
          },

          // Subject
          {
            "type": 3,
            "id": 895,
            "name": "CF",
            "longName": "Cooles Fach",
            "displayname": "CF",
            "alternatename": "",
            "backColor": "#eeeeee",
            "canViewTimetable": false,
            "roomCapacity": 0
          },

          // Room
          {
            "type": 4,
            "id": 41,
            "name": "311",
            "longName": "10b",
            "displayname": "311",
            "alternatename": "",
            "canViewTimetable": false,
            "roomCapacity": 33
          },

          // Student
          {
            "alternatename": "",
            "canViewTimetable": true,
            "displayname": "Prakash Fernanda",
            "id": 456,
            "longName": "Prakash",
            "name": "Prakash7534",
            "roomCapacity": 0,
            "type": 5
          }
        ]
      },
      "lastImportTimestamp": 1647072062865
    }
  }
}  

In the elements section in the output I only get the teachers short names. So I probably need to make an request to the "official" getTeacher jsonrpc endpoint and match the ids.

And another downside of this is, that I don't get compleately cancelled lessons.

the schoolname from the webite is: OSZ+IMT

i think the + in the schoolname is not working here?

Fehler beim Login: Failed to login. {"jsonrpc":"2.0","id":"error","error":{"message":"invalid schoolname","code":-8500}}

In the docs (https://webuntis.noim.me/classes/WebUntisAnonymousAuth.html#getTimetableForWeek) is says:

Optional formatId: number = 1

set to 1 to include teachers, 2 omits the teachers in elements response

But I get no teachers in the return.
Can I just use the getTimetableForRange, pass in the range of the week and get a correct response from there?

Tom hat dich am September 11, 2018 at 06:58PM gehated

Benefits:

• module safety
• better typescript support
• nicer docs
• better support for esmodules

I am trying to access the teaching content of my classes, but they don’t seem to be available. Does that feature not exist yet?

{ bkText: lesson.lstext, subsText: lesson.substText, infoText: lesson.info, remarkText: lesson.bkRemark, }

I tried all of these texts, but all are undefined for lessons with teaching content

how do I validate a session, I use qr-code login, it logs in perfectly but I'm unable to verify the session an thus am unable to get any other data
here's the error log:

(node:2476) UnhandledPromiseRejectionWarning: Error: Current Session is not valid
    at WebUntisQR._request (/home/pi/RMUntis4/node_modules/webuntis/index.js:548:71)
    at processTicksAndRejections (internal/process/task_queues.js:95:5)
    at async WebUntisQR.getOwnTimetableForToday (/home/pi/RMUntis4/node_modules/webuntis/index.js:252:16)
(Use `node --trace-warnings ...` to show where the warning was created)
(node:2476) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag `--unhandled-rejections=strict` (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 1)
(node:2476) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

Unfortunately, for 11th and 12th grade the school decided to put all lessons in everybody's timetables. So my kids see lessons they don't have. However, it would still be nice to see which lessons are omitted.

But retrieving a timetable leads to an error. Not sure why. Potentially, because of the parallel lessons?

Example program

import { WebUntis } from 'webuntis';
const untis = new WebUntis('...');
await untis.login();
console.log(await untis.getTimetableForToday())

returns

C:\dev\Untis\node_modules\webuntis\dist\webuntis.js:564
      throw new Error("Server didn't return any result.");

Error: Server didn't return any result.
    at Base._request (C:\dev\Untis\node_modules\webuntis\dist\webuntis.js:564:13)
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
    at async Base.getTimetableForToday (C:\dev\Untis\node_modules\webuntis\dist\webuntis.js:340:12)
    at async file:///C:/dev/Untis/app.js:13:13

I would love to provide you with the login data, if you have time to look further into this.

Im trying to get the timetables with this code, but I don't know what the base url is for myschool, the current code:

import { WebUntisAnonymousAuth, WebUntisElementType } from "webuntis";

const untis = new WebUntisAnonymousAuth(
  "SC-Celje",
  "https://ajax.webuntis.com/WebUntis/?school=sc-celje"
);

await untis.login();
const classes = await untis.getClasses();
const timetable = await untis.getTimetableForToday(
  classes[10].id,
  WebUntisElementType.CLASS
);
console.log(timetable);

Tom hat dich am September 11, 2018 at 06:58PM gehated

Tom hat dich am December 22, 2018 at 04:31PM gehated

I looked at the documentation and the outputs of for example getOwnClassTimetableForRange but cannot seem to find anything

I was wondering if I somehow can find out if there is an exam in a specific lesson, for example gotten from a timetable. I could get all of the information about a lesson except for the red marked ones.

Hey,

When I get my Timetable using untis.getOwnTimetableForToday();, it gets returned in a completely random order.

Is there a way to sort it according to startTime or endTime?

If so please let me know. :)

Hi,
I am using the WebUntis plugin as part of a module of the magic mirror and it is throwing error like this:
/home/pi/MagicMirror/modules/MMM-untis/node_modules/webuntis/index.js:233
...additionalOptions,
^^^
SyntaxError: Unexpected token ...
at Object.exports.runInThisContext (vm.js:78:16)
at Module._compile (module.js:543:28)
at Object.Module._extensions..js (module.js:580:10)
at Module.load (module.js:488:32)
at tryModuleLoad (module.js:447:12)
at Function.Module._load (module.js:439:3)
at Module.require (module.js:498:17)
at require (internal/module.js:20:19)
at Object. (/home/pi/MagicMirror/modules/MMM-untis/node_helper.js:2:15)
at Object. (/home/pi/MagicMirror/modules/MMM-untis/node_helper.js:132:3)

If I "correct" the syntax by removing the "..." then the code works, but the timetable request is not considering the range provided by additionalOptions.startDate and additionalOptions.endDate:
async _timetableRequest(id, type, startDate, endDate, validateSession = true) {
const additionalOptions = {};
if (startDate) {
additionalOptions.startDate = this.convertDateToUntis(startDate);
}
if (endDate) {
additionalOptions.endDate = this.convertDateToUntis(endDate);
}

    return this._request(
        'getTimetable',
        {
            options: {
                id: new Date().getTime(),
                element: {
                    id,
                    type
                },
                additionalOptions,
                showLsText: true,
                showStudentgroup: true,
                showLsNumber: true,
                showSubstText: true,
                showInfo: true,
                showBooking: true,
                klasseFields: ['id', 'name', 'longname', 'externalkey'],
                roomFields: ['id', 'name', 'longname', 'externalkey'],
                subjectFields: ['id', 'name', 'longname', 'externalkey'],
                teacherFields: ['id', 'name', 'longname', 'externalkey']
            }
        },
        validateSession
    );
}

Any idea how to fix it?
Regards se7en241

Hello
I am trying to log in with this POST:
{ method: 'POST', url: "/WebUntis/jsonrpc.do?school=Heyerdahl", data: { id: this.id, method: 'authenticate', params: { user: '#anonymous#', client: this.id }, jsonrpc: '2.0' }

But I get a weird error message in return:
Error: Failed to login. {"jsonrpc":"2.0","id":"DiscordBotUntisQuery","error":{"message":"Index: 1, Size: 1","code":-8998}}

Does anyone know if I am doing anything wrong, and what I am doing wrong?

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

Hello I wanted to use this library with React Native but this is not possible because React Native has no standard node modules what can I do?

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

Tom hat dich am December 22, 2018 at 04:30PM gehated

Hi, this error occurred in my setup, I dont know where it is from, I only got it in sentry....

Hey, i dont know my School Server URL.
I can find my School here: https://webuntis.com/
Can i take the url from the school login of this website?
Cant see any Server/URL Info in the WebUntis App.

Thanks for your help!

I was wondering why my sessionid keeps getting invalid after roughly 10min.
So I investigated a bit...

As I turns out, the official API spec says

An application should always logout as soon as possible to free system resources on the server.

I propose adding this recommendation to the sdk doc. Furthermore, it might make sense to add the official spec pdf into the repo after the license has been clarified.

I wanted to discuss it before investing some time for a then rejected PR :)

Hello,

I have got the api docs with a email to helpdesk. And now I have a few questions.

1. What version of the documentation you're using? And how much pages you have? (Mine is from 20.09.2018 and has 19 pages)

2. In mine there is nothing about getting homeworks and a few other stuff. Only json rpc and nothing about a rest API. Did you figured out the rest api yourself?

3. The guy from the untis team, who send me the documentation said:

The query interval of your program must NOT be less than 60 minutes. Otherwise the query will be blocked by the system.

Have you any experience with testing your program? Did you got blocked?

4. And in my sheet I can't find anything about the secret authentication and anonymous login. Did you figured out this also yourself?

Best regards.

I want to get the room number of this 'entry' in the for loop. When I query it, I only get '[object Object]'.

const time = parseInt('' + date.getHours() + date.getMinutes())

if (time >= 745 && time <= 915) {
	entries = timetable.filter(item=>item.startTime=="745")
	for (var i = entries.length - 1; i >= 0; i--) {
	        str = str + entries[i].sg + '\n'
	}
       console.log(str)
}

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.