API

autocomplete

Der Parameter ?action=autocomplete erzeugt eine alphabetisch sortierte Liste von Treffern zu einem Suchwort oder Wortanfang (case insensitive). Gesucht wird in Titeln und Alternativtiteln, beispielsweise wird bei der Suche nach "bach" auch Charles Gounod über das Pseudonym "Bach-Gounod" gefunden.

Die Rückgabe erfolgt als einfache Liste aus Titel, Entitätstyp und interner ID.

Beispiel Ausgabe Autovervollständigung "bach" (php):

array (
  0 => 
  array (
    0 => '"Die Kunst der Fuge" Contrapunctus 1 bis 19 und Orgelchoral: "Vor deinen Threon tret ich hiermit" (Bach, Johann Sebastian)',
    1 => 'work',
    2 => '21954',
  ),
  1 => 
  array (
    0 => '1. Akademisches Konzert, Volkshaus (Jena), 13.4.1946 19:00',
    1 => 'event',
    2 => '37459',
  ),
  2 => 
  array (
    0 => '1. Sonate G-Dur für Violoncello und Cembalo (Bach, Johann Sebastian)',
    1 => 'work',
    2 => '21593',
  ),
  3 => 
  array (
    0 => '1. Suite G-Dur für Violoncello allein (Bach, Johann Sebastian)',
    1 => 'work',
    2 => '21590',
  ),

Forlgende Parameter stehen zur Verfügung:

get

Der Parameter ?action=get gibt die Eigenschaften eines oder mehrerer Datensätze zurück, in der Form Datensatztyp(en) → ID(s) → Eigenschaft(en) → Wert(e).

Beispiel Ausgabe Johann Sebastian Bach (ID=88, php):

array (
  'person' => 
  array (
    88 => 
    array (
      'uid' => 88,
      'title' => 'Bach, Johann Sebastian (1685–1750)',
      'slug' => 'bach-johann-sebastian-1685-1750',
      'score' => 12121,
      'categories' => 
      array (
        0 => 
        array (
          'label' => 2,
        ),
      ),
      'names' => 
      array (
        0 => 
        array (
          'name' => 'Bach, Johann Sebastian',
          'order' => 1,
          'authority' => 1076,
        ),
        1 => 
        array (
          'name' => 'Bach',
          'order' => 2,
          'authority' => 1076,
        ),
        2 => 
        array (
          'name' => 'Bach, G. S.',
          'order' => 3,
          'authority' => 1076,
        ),
      ...
    ),
  ),
)

Folgende Parameter stehen zur Verfügung:

query

Der Parameter ?action=query führt eine Suche aus, analog zur einfachen (Volltext-)Suche oder komplexen Profi-Suche unter Recherche. Dabei wird basierend auf den Such-Parametern zunächst eine Liste von Veranstaltungen erzeugt und je nach gewünschtem Entitätstyp (Orte, Personen, Werke, usw.) aus diesen Veranstaltungen die angezeigten Treffer.

Die Rückgabe besteht aus einer Übersicht zur Trefferanzahl in den Entitätstypen ("count") und bis zu 1000 Treffern selbst ("records").

Beispiel Volltextsuche "bach", Veranstaltungsliste (php):

array (
  'count' => 
  array (
    'event' => 11020,
    'work' => 7280,
    'person' => 3192,
    'series' => 412,
    'corporation' => 338,
    'location' => 1463,
    'source' => 237,
  ),
  'records' => 
  array (
    'event' => 
    array (
      8638 => 
      array (
        'uid' => 8638,
        'persons' => 
        array (
          'count' => 7,
          'person' => 
          array (
            'uid' => 2810,
            'names' => 
            array (
              0 => 
              array (
                'name' => 'Biller, Georg Christoph',
                'order' => 1,
                'authority' => 23560,
              ),
              1 => 
              array (
                'name' => 'Biller, Georg C.',
                'order' => 2,
                'authority' => 23560,
              ),
              ...
            ),
            ...
          ),
          ...
        ),
        ...
      ),
      ...
    )
  )
)

Die Trefferliste ("records") lässt sich nach verschiedenen Kriterien sortieren und in den Ergebnissen blättern.

Folgende Parameter stehen zur Verfügung: