BeeCollect API: GET Request-Syntax

Einfache, nur lesende Abfragen von Daten über die BeeCollect API erfolgen über GET-Requests mit einer einheitlichen URL-Syntax. Nach den Regeln der RESTful-Webservices werden über die gleiche URL stets auch die gleichen Informationseinheiten erreicht. Das gleiche Objekt bzw. die gleiche URL können über eine konstant gleiche URL abgerufen werden.

Das Abfrageergebnis wird dabei je nach Konfiguration der Abfrage als JSON- oder XML-Struktur geliefert.

Folgende Syntax wird beim Aufbau der URL verwendet:

 https://<url>[:<port>]/modules/<module_id>/{searches/<search_id>|items/{all|count|<item_id>[/<subcategory>/{all|count|<subitem_id>}]}} 

Die einzelnen Elemente haben dabei folgende Bedeutung:

  • url: vollständige URL oder IP-Adresse des API-Servers
  • port: konfigurierter Port des API-Servers (typisch sind hier 443 oder 8080
  • modules: Fixwert, Zugriff auf die Module von MuseumPlus
  • module_id: Nummer/ID des abgefragten Moduls
  • items: Fixwert, Zugriff auf die Datensätze eines Moduls
  • all: Fixwert, Zugriff auf alle Datensätze eines Moduls
  • count: Fixwert, Zugriff auf die Anzahl der Datensätze eines Modul
  • item_id: Nummer/ID des abgefragten Datensatzes
  • subcategory: Bezeichnung der Unterelemente eines Moduls (z.B. dimensions)
  • all: Fixwert für Zugriff auf alle Unterelemente eines Moduls
  • count: Fixwert für Zugriff auf die Anzahl der Unterelemente eines Moduls
  • Subitem_id: Nummer/ID des abgefragten Unterelements
  • searches: Fixwert, Zugriff auf definierte Suchen eines Moduls
  • search_id: ID der definierten Suche eines Moduls (als GUID)

Unterstützt werden aktuell die folgenden Module:

  • Sammlung: module_id = 21
  • Adressen: module_id = 22
  • Künstler/Beteiligte: module_id = 30
  • Veranstaltung: module_id = 38
  • Literatur: module_id = 39
  • Ausstellung: module_id = 40
  • Fotobestellung: module_id = 47
  • Ereignisse: module_id = 54

Die Bezeichnungen für die Unterelemente sind jeweils modulspezifisch. Eine Liste der bei den einzelnen Modulen unterstützten Unterelemente finden Sie in der Abfrage-Dokumentation des jeweiligen Moduls.

 

Abfragebeispiele

Abfrage der Anzahl an Datensätzen im dem Modul Veranstaltung 

(Modulnummer 38):

https://my-url:8080/modules/38/items/count

Abfrage aller Datensätze aus dem Modul Literatur 

(Modulnummer 39):

https://my-url:8080/modules/39/items/all

Abfrage des Künstlers mit der Datensatznummer 12296 aus dem Modul Künstler/Beteiligte
(Modulnummer 30):

https://localhost:11077/modules/30/items/12296

Abfrage-Ergebnis:

[
  {
    "KueId": 12296,
    "KueMutationD": "2008-02-13T00:00:00",
    "KueMitarbeiterS": "USER1",
    "KueAufId": 175,
    "KueTypS": "Person",
    "KueDefaultL": null,
    "KueVorNameS": "Franz",
    "KueNameS": "Hals",
    "KueAliasS": null,
    "KueSortierungS": "Hals Franz",
    "KueGeburtJahrS": null,
    "KueGeburtOrtS": null,
    "KueGeburtLandS": "Niederlande",
    "KueTodesJahrS": null,
    "KueTodesOrtS": "Haarlem",
    "KueTodesLandS": "Niederlande",
    "KueFunktionS": "Maler",
    "KueAdrId": null,
    "KueBiographieKurzM": null,
    "KueReserve01M": null,
    "KueReserve02M": null,
    "KueA01M": null,
    "KueA02M": null,
    "KueA03M": null,
    "KueA04S": null,
    "KueA05S": null,
    "KueA06S": null,
    "KueA07S": null,
    "KueA08S": null,
    "KueA09S": null,
    "KueA10S": null,
    "KueA11S": null,
    "KueTransferId": 856,
    "KueGesperrtS": null,
    "KueStandardS": null,
    "KueGeschlechtS": "männlich",
    "KueNationS": "NL",
    "KueGeburtstagD": null,
    "KueTodestagD": null,
    "KueJahrVonL": null,
    "KueJahrBisL": null,
    "KueDatierungS": null,
    "KueGeburtstagS": null,
    "KueTodestagS": null,
    "KueGenDatumD": null,
    "KueGenPersonS": null,
    "KueHistAdrM": null,
    "KueQuelleM": null,
    "KueGeoEthnieS": null,
    "KueInsertS": null
  }
]