BeeCollect API: PUT Request-Syntax

Die Aktualisierung vorhandener Daten über die BeeCollect API erfolgt über PUT-Requests. Dabei wird über eine einheitliche URL-Syntax angegeben, welcher Datensatz in der MuseumPlus/BeeCollect-Datenbank aktualisiert werden soll.

Die zu schreibenden Daten werden als JSON-Struktur im Body des Requests übermittelt.

Folgende Syntax wird beim Aufbau der URL verwendet:

https://<url>[:<port>]/modules/<module_id>/items/<item_id>[/<subcategory>/<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
  • module_id: Nummer/ID des abgefragten Moduls
  • item_id: Nummer/ID des abgefragten Datensatzes
  • subcategory: Bezeichnung der Unterelemente eines Moduls (z.B. dimensions im Modul Sammlung [21])
  • subitem_id: Nummer/ID des abgefragten Unterelements

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.

Aktualisierung des Datensatzes mit der ID 653 im Modul Veranstaltung 
(Modulnummer 38):

URL

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

Header

POST /modules/38/items/653 HTTP/1.1
Host: 192.168.0.150
User-Agent: BeeCollect Professional 1.0
Authorization: Basic YWRtaW46c2VjcmV0
Connection: keep-alive
Content-Type: application/json
Content-Length: 187

Body

[
  {
    "VanStatusS": "Geplant",
    "VanTitelS": "Lange Nacht der Museen",
    "VanDatumD": "2016-01-23T00:00:00",
    "VanZeitVonS": "15.00",
    "VanZeitBisS": "00.00",
  }
]