diff --git a/README.md b/README.md index b107e0a3955567ccea5273df34696fd57140494c..3448f1649d58e41877c0e0dfe84a83318fcc1eea 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ Gibt dann zurück: Den `<access-token>` kann man dann bei späteren, authorisierten Requests als Header mitsenden: `Authorization: Bearer <access-token>` -**`GET https://mobil.itmc.tu-dortmund.de/oauth2/v2/tokeninfo`** (mit Auth): +**`GET` `https://mobil.itmc.tu-dortmund.de/oauth2/v2/tokeninfo`** (mit Auth): ```json { @@ -72,7 +72,7 @@ Den `<access-token>` kann man dann bei späteren, authorisierten Requests als H ### Tickets auflisten: -**`GET https://mobil.itmc.tu-dortmund.de/ticket/v4/tickets`** (mit Auth): +**`GET` `https://mobil.itmc.tu-dortmund.de/ticket/v4/tickets`** (mit Auth): ```json [ @@ -85,7 +85,7 @@ SemesterId ist z.B. `20211` für SoSe 2021 und `20212` für WiSe 2021/2022 ### Ticket als PNG anfordern: -**`GET https://mobil.itmc.tu-dortmund.de/ticket/v4/png-tickets/<semesterId>`** (mit Auth): +**`GET` `https://mobil.itmc.tu-dortmund.de/ticket/v4/png-tickets/<semesterId>`** (mit Auth): ```json { @@ -102,50 +102,182 @@ SemesterId ist z.B. `20211` für SoSe 2021 und `20212` für WiSe 2021/2022 ### Liste der Semester: -**`GET https://mobil.itmc.tu-dortmund.de/lsf/v3/semesters`** +**`GET` `https://mobil.itmc.tu-dortmund.de/lsf/v3/semesters`** ### Semester-Infos: -**`GET https://mobil.itmc.tu-dortmund.de/lsf/v3/20211/header/`** +**`GET` `https://mobil.itmc.tu-dortmund.de/lsf/v3/20211/header/`** ### Navigation im Veranstaltungsbaum: -**`GET https://mobil.itmc.tu-dortmund.de/lsf/v3/20211/header/118250`** +**`GET` `https://mobil.itmc.tu-dortmund.de/lsf/v3/20211/header/118250`** ### Veranstaltungsdetails: -**`GET https://mobil.itmc.tu-dortmund.de/lsf/v3/20211/courseDetails/235739`** +**`GET` `https://mobil.itmc.tu-dortmund.de/lsf/v3/20211/courseDetails/235739`** -## Personensuche +## Personal + +### Personensuche + +**`GET` `https://mobil.itmc.tu-dortmund.de/employee-data/v2/employees?q=<suchstring>&offset=0&limit=10`** + +```json +{ + "data": [ + { + "tudoid": "DE1130000033013", + "displayName": "Prof. Dietmar Schmetz", + "forename": "Dietmar", + "surname": "Schmetz", + "email": "ditmar.schmetz@tu-dortmund.de", + "hrMainPosition": "", + "primaryPhoneNumber": null, + "organizationIds": [], + "employeeExtension": { + "descriptionDe": null, + "descriptionEn": null, + "portraitPubliclyVisible": false, + "portrait": null, + "addons": null, + "faxVisibility": "PUBLIC" + }, + "visibleAvatar": false + }, + { + "tudoid": "DE1130000038944", + "displayName": "Prof. Dietmar Fröhlich", + "forename": "Dietmar", + "surname": "Fröhlich", + "email": "dietmar.froehlich@tu-dortmund.de", + "hrMainPosition": "", + "primaryPhoneNumber": "+49-231-755-3530", + "organizationIds": [], + "employeeExtension": { + "descriptionDe": null, + "descriptionEn": null, + "portraitPubliclyVisible": false, + "portrait": null, + "addons": null, + "faxVisibility": "PUBLIC" + }, + "visibleAvatar": false + } + ], + "pagination": { + "offset": 0, + "limit": 20, + "total": 2 + } +} +``` + + +### Details zu einer Person: + +**`GET` `https://www.tu-dortmund.de/webapps-backend/employee-data/v2/employees/<tudoid>/numbers`** + +```json +{ + "data": [ + { + "type": "ext", + "e164Num": "+49-231-755-7550", + "buildingShortname": "HG1", + "street": "August-Schmidt-Straße 4", + "roomName": "303A", + "roomId": 61793, + "organizationId": "10000353", + "organizationName": "Rektorat", + "tudoid": "DE1130000032097" + }, + { + "type": "fax", + "e164Num": "+49-231-755-7557", + "buildingShortname": "HG1", + "street": "August-Schmidt-Straße 4", + "roomName": "301", + "roomId": 61790, + "organizationId": "10000353", + "organizationName": "Rektorat", + "tudoid": "DE1130000032097" + } + ], + "pagination": null +} +``` + + +### Organisationssuche + + +**`GET` `https://www.tu-dortmund.de/webapps-backend/employee-data/v2/organizations?q=<suchstring>&offset=0&limit=20`**: + +```json +{ + "data": [ + { + "oid": "10000353", + "description": "Rektorat", + "departmentDescription": "Rektorat", + "pOid": "10000008" + }, + { + "oid": "10002450", + "description": "Stabsstelle Strategie u. Rektoratsangelegenheiten", + "departmentDescription": "Dezernat 2 Hochschulentwicklung und Organisation", + "pOid": "10000368" + } + ], + "pagination": { + "offset": 0, + "limit": 10, + "total": 2 + } +} +``` + + +### Details zu einer Organisation + +**`GET` `https://www.tu-dortmund.de/webapps-backend/employee-data/v2/organizations/<organizationId>`**: + +```json +{ + "oid": "10000686", + "description": "Fraunhofer", + "departmentDescription": "Fakultät Informatik", + "pOid": "10000644" +} +``` -**`GET https://mobil.itmc.tu-dortmund.de/employee-data/v2/employees?q=<suchstring>&offset=0&limit=10`** ## Abfahrtsmonitor ### Liste der Stationen: -**`GET https://mobil.itmc.tu-dortmund.de/departure/v1/stations`** +**`GET` `https://mobil.itmc.tu-dortmund.de/departure/v1/stations`** ### Abfahrten an einer Station: -**`GET https://mobil.itmc.tu-dortmund.de/departure/v1/stations/20000472/departures`** +**`GET` `https://mobil.itmc.tu-dortmund.de/departure/v1/stations/20000472/departures`** ## Gebäude -**`GET https://service.tu-dortmund.de/o/edu.udo.itmc.dev.presencetracking/conjectfm/rest/v2/buildings`** +**`GET` `https://service.tu-dortmund.de/o/edu.udo.itmc.dev.presencetracking/conjectfm/rest/v2/buildings`** -**`GET https://service.tu-dortmund.de/o/edu.udo.itmc.dev.presencetracking/conjectfm/rest/v2/buildings/<building-id>/floors`** +**`GET` `https://service.tu-dortmund.de/o/edu.udo.itmc.dev.presencetracking/conjectfm/rest/v2/buildings/<building-id>/floors`** -**`GET https://service.tu-dortmund.de/o/edu.udo.itmc.dev.presencetracking/conjectfm/rest/v2/buildings/floors/<floor-id>/rooms`** +**`GET` `https://service.tu-dortmund.de/o/edu.udo.itmc.dev.presencetracking/conjectfm/rest/v2/buildings/floors/<floor-id>/rooms`** Alternativer Endpunkt dieser API: `https://mobil.itmc.tu-dortmund.de/conjectfm/v2/buildings` @@ -154,7 +286,7 @@ Alternativer Endpunkt dieser API: `https://mobil.itmc.tu-dortmund.de/conjectfm/v ### Übersicht: -**`GET https://mobil.itmc.tu-dortmund.de/canteen-menu/v3/canteens`** +**`GET` `https://mobil.itmc.tu-dortmund.de/canteen-menu/v3/canteens`** ```json [ @@ -178,9 +310,9 @@ Alternativer Endpunkt dieser API: `https://mobil.itmc.tu-dortmund.de/conjectfm/v ### Menü: -**`GET https://mobil.itmc.tu-dortmund.de/canteen-menu/v3/canteens/<canteen-id>`** +**`GET` `https://mobil.itmc.tu-dortmund.de/canteen-menu/v3/canteens/<canteen-id>`** -**`GET https://mobil.itmc.tu-dortmund.de/canteen-menu/v3/canteens/<canteen-id>/2021-08-26?expand=true`** +**`GET` `https://mobil.itmc.tu-dortmund.de/canteen-menu/v3/canteens/<canteen-id>/2021-08-26?expand=true`** ```json [ @@ -238,7 +370,7 @@ Alternativer Endpunkt dieser API: `https://mobil.itmc.tu-dortmund.de/conjectfm/v ### Öffnungszeiten: -**`GET https://mobil.itmc.tu-dortmund.de/canteen-menu/v3/canteens/<canteen-id>/openings`** +**`GET` `https://mobil.itmc.tu-dortmund.de/canteen-menu/v3/canteens/<canteen-id>/openings`** ```json { @@ -255,7 +387,7 @@ Alternativer Endpunkt dieser API: `https://mobil.itmc.tu-dortmund.de/conjectfm/v ### Liste der verfügbaren Sondertiles abrufen: -**`GET https://mobil.itmc.tu-dortmund.de/tiles/v2`**: +**`GET` `https://mobil.itmc.tu-dortmund.de/tiles/v2`**: ```json [ @@ -300,7 +432,7 @@ Alternativer Endpunkt dieser API: `https://mobil.itmc.tu-dortmund.de/conjectfm/v ### Details zu den Tiles: -**`GET https://mobil.itmc.tu-dortmund.de/tiles/v2/<tile-id>`**: +**`GET` `https://mobil.itmc.tu-dortmund.de/tiles/v2/<tile-id>`**: ```json { @@ -337,7 +469,7 @@ Alternativer Endpunkt dieser API: `https://mobil.itmc.tu-dortmund.de/conjectfm/v ### SVG icons zu den Tiles: -**`GET https://mobil.itmc.tu-dortmund.de/tiles/v2/<tile-id>/icon`**: +**`GET` `https://mobil.itmc.tu-dortmund.de/tiles/v2/<tile-id>/icon`**: ``` svg data halt... @@ -347,7 +479,7 @@ svg data halt... ## Corona-Tracing: -**`GET https://mobil.itmc.tu-dortmund.de/presencetracking-backend/v1/contactdata/data`** (mit Auth): +**`GET` `https://mobil.itmc.tu-dortmund.de/presencetracking-backend/v1/contactdata/data`** (mit Auth): ```json { @@ -361,7 +493,7 @@ Liefert also die im Service-Portal hinterlegten Adressdaten ## Stundenplan -**`GET https://mobil.itmc.tu-dortmund.de/lsf/v3/lsfEvents?date=2021-07-06`** (mit Auth): +**`GET` `https://mobil.itmc.tu-dortmund.de/lsf/v3/lsfEvents?date=2021-07-06`** (mit Auth): ```json [ @@ -455,7 +587,7 @@ Liefert also die im Service-Portal hinterlegten Adressdaten ## "Leistungen" / BOSS-Prüfungsdaten -**`GET https://mobil.itmc.tu-dortmund.de/lsf/v3/courses`** (mit Auth): +**`GET` `https://mobil.itmc.tu-dortmund.de/lsf/v3/courses`** (mit Auth): ```json [ @@ -515,7 +647,7 @@ Liefert also die im Service-Portal hinterlegten Adressdaten ### CampusID / Digitaler Bibliotheksausweis als QR-Code anfordern: -**`GET https://mobil.itmc.tu-dortmund.de/campus-id/v1/totp/secret`** (mit Auth) +**`GET` `https://mobil.itmc.tu-dortmund.de/campus-id/v1/totp/secret`** (mit Auth) ```json { @@ -539,7 +671,7 @@ Zeitfenster für TOTP generation: 30 Sekunden ### CampusID / Digitalen Bibliotheksausweis überprüfen: -**`GET https://mobil.itmc.tu-dortmund.de/campus-id/v1/totp/valid?uuid=<uuid>&totp=<6-digit-totp>`**: +**`GET` `https://mobil.itmc.tu-dortmund.de/campus-id/v1/totp/valid?uuid=<uuid>&totp=<6-digit-totp>`**: ```json { @@ -552,7 +684,7 @@ Zeitfenster für TOTP generation: 30 Sekunden ### Liste der Vormerkungen -**`GET https://mobil.itmc.tu-dortmund.de/library-account/v3/items/reserved`** (mit Auth): +**`GET` `https://mobil.itmc.tu-dortmund.de/library-account/v3/items/reserved`** (mit Auth): ```json [] @@ -560,7 +692,7 @@ Zeitfenster für TOTP generation: 30 Sekunden ### Liste der Ausleihen -**`GET https://mobil.itmc.tu-dortmund.de/library-account/v3/items/borrowed`** (mit Auth): +**`GET` `https://mobil.itmc.tu-dortmund.de/library-account/v3/items/borrowed`** (mit Auth): ```json [] @@ -569,7 +701,7 @@ Zeitfenster für TOTP generation: 30 Sekunden ### Liste der Bestellungen -**`GET https://mobil.itmc.tu-dortmund.de/library-account/v3/items/ordered`** (mit Auth): +**`GET` `https://mobil.itmc.tu-dortmund.de/library-account/v3/items/ordered`** (mit Auth): ```json [] @@ -578,7 +710,7 @@ Zeitfenster für TOTP generation: 30 Sekunden ### Liste der Säumnisgebühren -**`GET https://mobil.itmc.tu-dortmund.de/library-account/v3/items/fees`** (mit Auth): +**`GET` `https://mobil.itmc.tu-dortmund.de/library-account/v3/items/fees`** (mit Auth): ```json []