Allgemeine URL-Parameter

URL-Parameter

name Datentyp Zweck
cache "true"/"1" oder "false"/"0" Die meisten Anfragen werden per Default gecached.
voc Kürzel oder URI Filter auf ein Vokabular bei Abfrage von Konzepten. Das Kürzel (vocid) steht im Feld "notation" der Informationen zu einem Vokabular. Die URI steht im Feld "uri" der Informationen zu einem Vokabular. URIs fangen im Gegensatz zu Kürzeln mit /^[a-z]+:/ an.

Teilmengen von Vokabularen werden als "subset" bezeichnet. Diese Auswahlen / Ausschnitte aus Vokabularen werden ebenfalls über den voc-Parameter angesprochen. Um im Kontext des Subsets zu bleiben, muss der Parameter dann bei allen Endpoints genutzt werden.
format "jskos", "marcxml", "marcjson", "turtle", "ntriples" Legt das Ausgabeformat eines Datensatzes fest. Das Standardformat ist jskos.
Alle anderen Formate werden aktuell aus jskos generiert.
type Kürzel oder URI oder kommaseparierte Liste daraus Filter auf einen oder mehrere Datensatztyp/en bei Abfrage von Konzepten per /suggest und /search.
limit Positive Integer Maximale Anzahl der zurückzuliefernden Treffer
offset Positive Integer Benennt den ersten zurückzugebenden Eintrag einer Suche. Zusammen mit dem Limit-Parameter lässt sich so durch Suchergebnisse blättern.
subset "true"/"1" oder "false"/"0" (default) Nur /voc-Endpoint. Entscheidet, ob auch Informationen über Subsets zurückgeliefert werden.
language Alpha2-Code aus ISO 639-1 Mit dem Parameter language kann eine gewünschte Sprache ausgewählt werden (Wert aus ISO 639-1), ansonsten wird der HTTP-Header Accept-Language beachtet werden. Die tatsächlich zurückgelieferte Sprache wird im HTTP-Header Content-Language zurückgeliefert.
languages Alpha2-Codes aus ISO 639-1 Mit dem Parameter languages kann definiert werden, welche Sprachen für die Labels (prefLabel, altLabel, hiddenLabel) und verschiedenen Notes (scopeNote, definition, example, historyNote, note, changeNote) zurückgegeben werden. Ohne den Parameter werden Werte in allen Sprachen ausgegeben. Nur für Aufrufe, die JSKOS ausliefern.
uri URI Eindeutige URI (ein Datensatz kann ggf. mehrere URIs haben aber nie umgekehrt!)
id URI Eine URI aus dem Feld "offizielle URI" oder eine URI aus dem Feld "entsprechende URIs" mit dem Mapping-Typ "Exakte Übereinstimmung"
notation Kürzel oder String Kürzel eines Vokabulars oder Signatur/Nummer/Chiffre eines Konzept
use String
Kommaseparierte Liste		 Legt fest, welche Felder bei einer Autovervollständigungsanfrage berücksichtigt werden.
Mögliche Werte:
  • label
  • notation
sort "alphabet" oder "score" Nur Suggestdienst. Art der Sortierung der Treffer. Default: "alphabet"
properties String
Kommaseparierte Liste von Feldnamen		 Auswahl gewünschter JSKOS-Felder. Ist der Parameter leer wird eine festgelegte Liste von Standardfeldern angenommen, die je nach je nach Anfrage-Methode unterschiedlich sein kann.

Bei einfacher Auswahl von Feldern werden nur diese Felder (falls vorhanden) sowie einige Minimalfelder wie uri und prefLabel zurückgeliefert:

Minimalfelder sowie narrower und broader 
                      
properties=narrower,broader


Ein einzelnes Minus steht für nur die Minimalfelder 
                      
properties=-


Ein einzelner Stern steht für alle Felder (Standardfelder und ggf. zusätzliche Felder) 
                      
properties=*


Ein vorgestelltes Plus bedeutet, dass zusätzliche die Standardfelder gewünscht sind.

Standardfelder sowie modified 
                      
properties=+modified


Ein vorgestelltes Minus bedeutet, dass die aufgeführten Felder nicht benötigt werden.

Standardfelder ohne altLabel und scopeNote 
                      
properties=-altLabel,scopeNote

Unbekannte Feldnamen werden ignoriert.


Minimalfelder:
  • @context
  • uri
  • type
  • prefLabel
Standardfelder:
  • topConceptOf
  • inScheme
  • altLabel
  • identifier
  • notation
  • publisher
  • scopeNote
  • definition
  • startDate
  • endDate
Zusätzliche Felder:
  • example
  • historyNote
  • note
  • changeNote
  • hiddenLabel
  • narrower
  • broader
  • ancestors
  • mappings
  • relation
  • location
  • depiction
  • modified
  • startPlace
  • endPlace
  • partOf
  • distributions
callback String JSON mit Padding