MediaWiki-API-Ergebnis

{
    "batchcomplete": "",
    "query": {
        "pages": {
            "748": {
                "pageid": 748,
                "ns": 0,
                "title": "API",
                "revisions": [
                    {
                        "user": "Viola",
                        "timestamp": "2023-04-25T12:10:24Z",
                        "comment": "/* Letzte funktionale \u00c4nderungen */",
                        "contentformat": "text/x-wiki",
                        "contentmodel": "wikitext",
                        "*": "\n==Allgemein==\nDie API (application programming interface, w\u00f6rtlich \u201aAnwendungs\u00adprogrammier\u00adschnittstelle\u2018) erm\u00f6glicht es, dass andere Programme lesend (oder ggf. in definierten Ausnahmef\u00e4llen schreibend) an TraiNex angebunden werden. Diese Schnittstelle zur Programmierung von Anwendungen kann von berechtigten Programmierenden der Hochschule genutzt werden, um Daten in strukturierter Form aus den TraiNex-Datenbanken auszulesen (oder ggf. in definierten Ausnahmef\u00e4llen zu schreiben). Technische Details zur API werden NICHT hier im Wiki sondern in einem separaten Dokument beschrieben, was nur Kunden ausgeh\u00e4ndigt wird.<BR>\n\n<BR>\nFolgende API-Aufrufe und Funktionen sind grob m\u00f6glich<BR>\n* Lesen von Stammdaten/Adress-Daten/Semesterangaben\n* Lesen von Bewertungen/Noten\n* Aktualisieren/Anlegen von Stammdaten\n* Voreintragung von Bewertungen/Noten\n* Download von vorbereitetem Pr\u00fcfungstermin-XML\n* weitere Funktionen sind in Entwicklung und beschrieben in der separaten Dokumentation\n\n== Haftung, Datenschutz, ADV ==\n\nMit der \u00dcbergabe der Zugangsdaten f\u00fcr die Schnittstelle, ist es m\u00f6glich, lesend auf personenbezogene Daten der TraiNex-Nutzer zuzugreifen. Ebenfalls m\u00f6glich kann es ein, dass Stamm-Daten f\u00fcr Bewerber oder andere Personen oder Noten geschrieben oder ver\u00e4ndert oder geleert werden.\n\n* Die TraiNings-Online GmbH hat Vorkehrungen getroffen, um einen Missbrauch der Schnittstelle zu verhindern.\n* Die TraiNings-Online GmbH \u00fcbernimmt keinerlei Haftung f\u00fcr eine Ausnutzung der Schnittstelle durch unberechtigte oder berechtigte Dritte.\n* Die Vereinbarung zur Auftragsdatenvereinbarung sowie das Verfahrens-Verzeichnis der datenschutzrelevanten Prozesse sind seitens des Kunden (und nicht durch die TraiNings-Online GmbH) anzupassen.   \n* Ohne Zustimmung zum Haftungsausschluss kann die Schnittstelle aus haftungsrechtlichen Gr\u00fcnden nicht in Betrieb genommen werden. \n\u2003\n\n== Aktivierung ==\n\nDie Aktivierung der API erfolgt auf Wunsch durch [[TrOn]] und ist eine der [[Zusatzleistungen]]. Zur Aktivierung erhalten Sie Zugriff auf ein Word-Dokument, das die Details der Nutzung sowie m\u00f6glich Parameter beschreibt. Die Programmierung auf Seiten der Hochschule muss durch eine zust\u00e4ndige Person der Hochschule erfolgen.\n\n\n\n\n\n==Aufruf der API==\nDie API wird aufgerufen \u00fcber eine externe Seite, die au\u00dferhalb des TraiNex-Servers, aber in Deutschland, liegt. \nDie Seite kann in z.B. php, html oder ColdFusion geschrieben sein. Details sind beschrieben in der Dokumentation, die anforderbar ist.\n\n==Sicherheit==\nUsername und Passwort sowie API-ID werden festgelegt durch [[TrOn]] und dem Kunden mitgeteilt.\nDer Aufruf erzeugt Basic-Auth-Credentials. Jede Nutzung der API wird inkl. IP-Adresse registriert/protokolliert.  Die aufrufende IP-Adresse kann definiert sein. Ein Aufruf von au\u00dferhalb Deutschlands/\u00d6stereichs ist erschwert und nicht automatisch m\u00f6glich.<BR>\nZeiten des Abrufs k\u00f6nnen festgelegt sein (z.B. nur abends zwischen 18 und 19 Uhr). Details sind beschrieben in der Dokumentation, die anforderbar ist.\n\n==Output==\nEin Output eines Studierenden im JSON-Format kann wie folgt aussehen.\n\n[[Datei:json1.jpg]]\n\nEin Output eines Studierenden im CSV-Format kann wie folgt aussehen.\n[[Datei:json2.jpg]]\n\n==Zusatzfelder==\nDie API liefert Rohdaten in alternativen Formaten. Zu den Rohdaten geh\u00f6ren die Personal-Daten der Nutzenden wie Name, Geburtsdatum, Studiengruppenzugeh\u00f6rigkeit, Matrikelnummer oder Vorsemester. Der Output enth\u00e4lt nur die in Datenbanken gespeicherten Felder und keine berechneten Felder. Beispiel: Die Anzahl der Vorsemester ist in TraiNex gespeichert und kann direkt abgerufen werden. Die Anzahl der Fachsemester hingegen wird berechnet aus z.B. Studienstart, Studiengangssemester und Vorsemester etc. und kann nicht direkt abgerufen werden.<BR>\nEbenfalls nicht direkt abgerufen werden k\u00f6nnen verbundene Tabellen. Beispiel: Das Modulthema einer Pr\u00fcfung steht in einer Tabelle und die Noten einer studierenden Person in einer anderen Tabelle. Wenn eine Liste mit \"Noten der studierenden Person\" \u00fcber die API abgerufen werden k\u00f6nnen soll, so ist dies trainexseitig durch [[TrOn]] eine der [[Zusatzleistungen]].\n\n== Siehe auch ==\n*[[Schnittstelle]]\n\n==Letzte funktionale \u00c4nderungen==\n*M\u00e4rz 2023: Integration der [[API]] zu ChatGPT und anderen Open-AI-Sprachmodellen, um z.B. kreative \u00dcberschriftenvorschl\u00e4ge oder Anregungen f\u00fcr Titel oder Gliederungen zu erhalten\n*Februar 2023: Neues Sonderrecht 98 f\u00fcr \"[[API]]-Zusatzfunktionen\". \n*Dezember 2022: Erstellung einer Dokumentation, die separat von Kunden, die die API nutzen, angefordert werden kann.\n*Oktober 2022: [[API]]: M\u00f6glichkeit, den datensparsamen Output durch Zusatzbefehle zu erweitern, um Details von Studiengang oder Studierenden im Output zu erhalten\n*Oktober 2022: [[API]]: M\u00f6glichkeit, Noten von extern in die Noten-Voreintragstabelle in TraiNex einzutragen\n*Oktober 2022: [[API]]: Integration des Leistungs-Stands/Einzel-Noten f\u00fcr den Export\n*Oktober 2022: [[API]]: M\u00f6glichkeit, auf erzeugte [[Noten]]-Termine-json-Datei von extern zuzugreifen\n*August 2021: [[API]]: Verbesserung der Anwendungs\u00adprogrammier\u00adschnittstelle, um Bewerber-Daten auch schreibend in TraiNex einf\u00fcgen zu k\u00f6nnen\n*Januar 2021: Verbesserung der Anwendungs\u00adprogrammier\u00adschnittstelle, um TraiNex-Daten automatisch-lesend von anderen berechtigten Anwendungen abfragen und verwenden zu lassen (Beispiel: Matrikelnummer-Namens-Liste)"
                    }
                ]
            },
            "1": {
                "pageid": 1,
                "ns": 0,
                "title": "Main Page",
                "revisions": [
                    {
                        "user": "MediaWiki default",
                        "anon": "",
                        "timestamp": "2010-03-26T07:58:46Z",
                        "comment": "",
                        "contentformat": "text/x-wiki",
                        "contentmodel": "wikitext",
                        "*": "<big>'''MediaWiki has been successfully installed.'''</big>\n\nConsult the [http://meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software.\n\n== Getting started ==\n* [http://www.mediawiki.org/wiki/Manual:Configuration_settings Configuration settings list]\n* [http://www.mediawiki.org/wiki/Manual:FAQ MediaWiki FAQ]\n* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]"
                    }
                ]
            }
        }
    }
}