API Dokumentation

Beispiele und live Testen

Die Verwendung der API kann unter /kataloge/nklm/api/test getestet werden. Dort sind auch verschiedene Beispiele aufgeführt.

Aufruf

Grundsätzlich erfolg die Verwendung der API über den Aufruf einer URL nach dem Schema:
http://www.nklm.de/kataloge/nklm/api/[methode]/[parameter1_name]/[parameter1_wert]/[parameter2_name]/[parameter2_wert]
[methode] und Parameter in Paaren von [parameter_name] / [parameter_wert] müssen durch konkreter Werte ersetzt werden.
Ergebnisse werden im JSON-Format geliefert.

Methoden und ihre Parameter

Suche
Methode:suche
Beschreibung:Erlaubt die gezielte Suche nach Kompetenzen / Lernzielen.
Parameter:
suchtext
Zu suchender Text in der Beschreibung von Kompetenzen / Lernzielen.
ebene
Ebene der Kompetenzen / Lernziele. Mögliche Werte: 1, 2, 3
z.B. 5.1 => Ebene 1, 5.1.1.1 => Ebene 3
kapitel
Suche in bestimmtem Kapitel. Zu beachten: Der Wert dieses Paramters ist die eindeutige ID des Kapitels (s. Methode arbeitspaket). Nicht die Kapitelnummer
kompetenzebenen
Kompetenzebenen der Lernziele. Mögliche Werte: 1, 2, 3a, 3b
meilensteine
Meilensteine der Lernziele. Mögliche Werte: grundlagenkompetenz, wissenschaftskompetenz, famulaturkompetenz, pjkompetenz, weiterbildungskompetenz
fachbezug
Lernziele die einen Fachbezug zu dem angegebenen Fach haben.
suchergebnisse

Mögliche Werte:
ids: Die Ergebnisse werden als Liste von IDs zurückgegeben. Dies ist der Standardwert.
voll: Die Ergebnisse werden als Liste von JSON-Objekten mit allen möglichen Feldern zurückgegeben.
ausgewaehlt Die Ergebnisse werden als Liste von JSON-Objekten mit ausgewählten Feldern zurückgegeben. Die Auswahl erfolgt duch die Paramter ausschliessen oder einschliessen

ausschliessen
Eine durch Kommas getrennte Liste von Feldern, die nicht mit zurückgegeben werden sollen. Nur in Verbindung mit Parameter suchergebnisse/ausgewaehlt zu verwenden.
einschliessen
Eine durch Kommas getrennte Liste von Feldern, die mit zurückgegeben werden sollen. Nur in Verbindung mit Parameter suchergebnisse/ausgewaehlt zu verwenden.
referenzen

Mögliche Werte:
id: Referenzen auf andere Lernziele / Kapitel werden als ID angegeben. Dies ist der Standardwert.
text: Referenzen auf andere Lernziele werden als Ordnungsnummern angegeben.

Arbeitspakete
Methode: arbeitspakete
Beschreibung: Liefert eine Liste aller Arbeitspakete / Kapitel
Parameter: Unterstützt die Parameter suchergebnisse, ausschliessen, einschliessen, referenzen
Beschreibung s. Methode suche
Arbeitspaket
Methode: arbeitspaket
Beschreibung: Liefert ein Arbeitspaket / Kapitel als JSON-Objekt
Parameter:
id
Eindeutige ID des gewünschten Arbeitspakets / Kapitels
Unterstützt zudem die Parameter suchergebnisse, ausschliessen, einschliessen, referenzen
Beschreibung s. Methode suche
Lernziel
Methode: lernziel
Beschreibung: Liefert ein Lernziel als JSON-Objekt
Parameter:
id
Eindeutige ID des gewünschten Lernziels
Unterstützt zudem die Parameter suchergebnisse, ausschliessen, einschliessen, referenzen
Beschreibung s. Methode suche