get_rooms

Funktion

Verwenden Sie diese Funktion, um eine Liste aller in Verowa verfügbaren Räume zu erhalten. Die Einträge umfassen neben dem Raumnamen jeweils auch eine Verknüpfungs-ID zum Gebäude sowie dessen Bezeichnung und Adresse inkl. URL zur Beschreibungsseite.

Falls das Reservations-Modul installiert ist, gibt diese Funktion zu den reservierbaren Räumen diverse zusätzliche Informationen aus, z.B. die hinterlegten Regeln zu den reservierbaren Zeiten, Eigenschaften der Räume sowie Zeitfenster, in denen der jeweilige Raum reserviert werden kann.

Um alle Belegungen für einen bestimmten Raum abzufragen, verwenden Sie die Funktion get_occupancy_by_room.

Nicht alle Ortsangaben zu den Veranstaltungen haben eine Raum-ID. Falls die Ortsangabe in der vorgegebenen Liste nicht verfügbar ist, haben die User in Verowa die Möglichkeit, stattdessen einen Freitext zu erfassen. In diesem Fall wird dieser Text bei der Veranstaltung als «room_name» ausgegeben und die Raum-ID ist 0.

Resource URL

https://api.verowa.ch/get_rooms/:instance/:apikey/

Parameter

• Ihr Instanzname :instance
• Ihr API-Key :apikey

Beispiele

GET https://api.verowa.ch/get_rooms/demo/8209042b1786e26c355d4aea1b8c7b79/

Server-Antwort (Muster)

[
  {
    "room_id": 3,
    "room_name": "grosser Saal", [i]
Falls ein Gebäude nur einen einzigen Raum hat, z.B. die Kirche, ist der Raumname typischerweise leer.

    "room_short": "Sa", [i]
Das Raum-Kürzel wird typischerweise nur intern und für Übersichten genutzt

    "location_id": 2, [i]
Jeder Raum ist mit einem Gebäude verknüpft.

    "location_name": "Kirchgemeindehaus",
    "street": "Dorfstrasse 26",
    "postcode": "1234", [i]
PLZ, evtl. mit Länderkürzel, z.B. «D-12345»
 
    "city": "Musterhausen",
    "location_url": "https://ref-musterhausen.ch/gebaeude/kgh", [i]
URL zur Seite, auf der das Gebäude beschrieben wird; kann auch nur ein interner Pfad sein (z.B. «/gebaeude/pavillon.html»).
 
    "location_url_is_external": false; [i]
Z.B. bei einem Altersheim führt die URL oft auf eine externe Seite

    "attributes": [10, 51, 32], [i]
Alle Eigenschaften, die auf den Raum zutreffen; die Referenz dazu liefert die Funktion get_room_attributes.

    "renting_presets": {
      "renting_form": "1[foy]", [i]
enthält die ID des Formulars, über das der Raum buchbar ist (leer, wenn der Raum nicht buchbar ist – in diesem Fall sind die folgenden Angaben nicht verfügbar); in eckigen Klammern kann ein Voreinstellungs-Template spezifiziert werden

      "slots_text": "montags bis freitags, 8–12 Uhr (ohne Sommerferien und Feiertage)"
      "min_days_in_advance": "5", [i]
Anzahl Kalendertage mind. Vorlaufzeit; z.B. «W3» meint 3 Werktage, leer = keine Vorlaufzeit nötig

      "max_days_in_advance": 180, [i]
Max. so viele Tage im Voraus können Räume reserviert werden.

      "min_minutes": 30, [i]
So viele Minuten muss eine Reservation mind. dauern.

      "max_minutes: 240, [i]
So viele Minuten lang darf eine Reservation maximal dauern (0 = egal).

      "buffer_minutes", [i]
Pufferzeit zwischen Veranstaltungen in Minuten (0 = egal).

      "available_slots": [ [i]
Alle buchbaren Zeitfenster zu diesem Raum. Die aktuelle Belegung sowie Pufferzeiten sind bereits berücksichtigt.

        "2026-06-22 00:00-24:00", [i]
Zeitfenster dauern max. 24 Stunden.

        "2026-06-23 00:00-08:00",
        "2026-06-23 11:30-24:00",
        ...
      ]
  }
]

Zurück