get_room_attributes

Funktion

Für Filter bei Raumreservationssystemen lassen sich Verowa-seitig jedem Raum Eigenschaften zuordnen. Diese Funktion liefert eine Übersicht aller hinterlegten Eigenschaften. Welche Eigenschaft zu den jeweiligen Räumen gehört, kann über get_rooms abgefragt werden.

Die Eigenschaften sind gruppiert und geordnet, ausserdem ist für jede Gruppe festgelegt, wie der Filter sich verhalten soll:

• OR: Mindestens eine der ausgewählten Optionen muss zutreffen, weil mehrere Varianten infrage kommen. Passend z.B. für die Auswahl von Quartier, Nutzungsart oder Raumgrösse.
• AND: Jede der ausgewählten Optionen muss zutreffen. Passend z.B. für Muss-Kriterien bei Ausstattung, Infrastruktur oder Barrierefreiheit.
• XOR: Gibt vor, dass nur eine der Optionen ausgewählt werden darf (Prinzip Radio-Buttons). Passend für eindeutige Optionen, die sich gegenseitig ausschliessen, wie z.B. eine Nutzungsklasse (privat/geschäftlich).

Alle Attribute haben eine eindeutige ID, unabhängig von ihrer Position und Gruppenzugehörigkeit. Es werden nur Gruppen ausgegeben, die mind. 1 Attribut enthalten.

Es ist durchaus möglich, vereinfachte Filtersysteme anzubieten, die nicht alle verfügbaren Attribute berücksichtigen. Das hat auf die Auswahl im Zusammenhang mit den Eigenschaften der Räume keinen Einfluss.

Resource URL

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

Parameter

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

Beispiel

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

Server-Antwort (Muster)

[
  {
    "group_id": 4,
    "name": "Nutzung",
    "order_nb": 100,
    "filter_type": "OR", [i]
mind. 1 ausgewählte Option muss zutreffen

    "attributes": [
      {
        "attr_id": 7, [i]
diese IDs sind eindeutig über alle Gruppen

        "name": "Sitzung",
        "name_short": "", [i]
Kürzel, z.B. für eine Übersichtstabelle; kann leer sein

        "helptext": "", [i]
Hilfetext, gedacht z.B. für einen Tooltip; kann leer sein

        "order_nb": 10 [i]
bezieht sich auf die Reihenfolge innerhalb der Gruppe

      },
      {
        "attr_id": 3,
        "name": "Kurs / Weiterbildung",
        "name_short": "Kurs",
        "helptext": "Raum ist mit Wandtafel/Whiteboard und Schulungsmaterial ausgerüstet",
        "order_nb": 20
      },
      {
        "attr_id": 15,
        "name": "Feier / Bankett",
        "name_short": "Feier",
        "helptext": "",
        "order_nb": 25
      }
    ]
  },
  {
    "group_id": 9,
    "name": "Barrierefreiheit",
    "order_nb": 200,
    "filter_type": "AND", [i]
jede ausgewählte Option muss zutreffen

    "attributes": [
      {
        "attr_id": 8,
        "name": "rollstuhlgängig",
        "name_short": "",
        "helptext": "Der Raum ist ebenerdig oder per Lift erreichbar. Ein Behinderten-WC ist vorhanden.",
        "order_nb": 10
      },
      {
        "attr_id": 26,
        "name": "Induktionsschleife für Hörgeräte",
        "name_short": "Induktion",
        "helptext": "",
        "order_nb": 20
      }
    ]
  }
]

Zurück