Calendar API (iCal) Specification

If you provide us a specific iCal-API, we can read your calendar data and show the data in our timetable.

Calendar API Specification

Request: HTTPS POST

Content-Type: application/json
Algorithm: SHA256withRSA
Authorization: Test_Signature

Test_Body:
{"endDate":"2023-03-13","tenantId":"2030500","user":"b953ec5f-598a-4305-87c1-d4b5f95a28c7","startDate":"2023-03-10"}

- All parameters are required
- Parameters can be sent in any order
- Data for endDate is included in response
- Parameter "user" is the external uuid of the WebUntis user

Response: iCal

Processed values:

• only VEVENT type
• Fields:
  • required:
    • DTSTART:
    • DTEND:
  • optional:
    • UID: Unique id of the event: Starts with digits followed by "-" followed optionally by some text
    • STATUS: CONFIRMED (default), CANCELLED or TENTATIVE
    • SUMMARY: (Short) description
    • LOCATION: (Short) place for event
    • DESCRIPTION: (multi-line) description, can contain HTML links
  • Optional custom fields:
    • X_COLOR: Hex color with leading "#" e.g. #E09FF0
    • X_GROUPNAME: (school internal) grouping of events
    • X_LINK: URL to open the event in the external app
      This will create a new button with the name of the app (as the main menu name or the app) name)
      
      

Note: Calendar name is defined in the platform-application.

How can you verify WU identity