Zum Inhalt springen
Developer

BaseBookable

Orte und Buchungen7 EndpunkteEvent / BaseBookable

Liefert eine Liste der BaseBookable-Objekte.

GET/api/event/base_bookable

Query-Parameter

namestringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE
tokenstringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE
baseLocationstringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE
bookableTypestringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE
slugIdentifierstringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE
addressStreetLevelstringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE
addressCitystringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE
addressZipstringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE
addressCountrystringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE
addressGeoLatstringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE
addressGeoLngstringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE
idinteger
deletedbooleanDiese Eigenschaft markiert eine Entität als gelöscht / archiviert | Benötigtes Zugriffsrecht: SCOPE
billingModestringWie Buchungen zu diesem Buchbaren abgerechnet werden: BILLING_MODE_UPFRONT (null = vorab, Rechnung zum Buchungszeitpunkt) oder BILLING_MODE_USAGE (kostenlose Reservierung, nachgelagerte Abrechnung anhand der realen Nutzungsdaten) Auch im Standard: Die Mitglieder-App zeigt "Nutzung erfassen" nur für nutzungsabgerechnete Buchbare an. | Benötigt Zugriffsrecht: SCOPE
usageBillingIntervalstringAbrechnungsintervall für BILLING_MODE_USAGE: USAGE_BILLING_INTERVAL_PER_BOOKING oder USAGE_BILLING_INTERVAL_MONTHLY. Null = Einstellung event_real_usage_billing_mode verwenden.
maxActiveBookingsPerUserstringMaximale Anzahl aktiver (zukünftiger, nicht stornierter) Selbstbedienungsbuchungen, die eine Person gleichzeitig für dieses buchbare Objekt halten darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt. | Benötigt Zugriffs-Tag: SCOPE
maxAdvanceBookingHoursstringMaximale Anzahl Stunden, die eine Selbstbedienungsbuchung in der Zukunft beginnen darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt. | Benötigt Zugriffs-Tag: SCOPE
inventoryManagedbooleanAls Inventar erfasst (Inventar-Ausleihe): Die Geschäftsstelle übergibt den Eintrag und nimmt ihn zurück, mit Kaution und Erinnerungen. Wird nur verwendet, solange die Einstellung event_inventory_enabled aktiv ist. | Benötigt Zugriffs-Tag: SCOPE
inventoryNumberstringInventarnummer des Eintrags (Inventarnummer). | Benötigt Zugriffs-Tag: SCOPE
createdstring
searchStringstringText, nach dem in der Liste gesucht wird
orderFieldNamestringName des Bestellfelds
orderFieldSortstringSortiermodusErlaubt: DESCASC
pageintegerSeite der Liste
pageSizeintegerAnzahl der Einträge je Seite
withMaxPageNumberstringgibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Liefert eine Liste der BaseBookable-Objekte.array<BaseBookable>

Felder anzeigen (79)
  • ticketSeatingPlanIdinteger

    ID des Platzplans des Raums, auch für die öffentliche Serialisierung.

  • baseLocationBaseLocation4
    Felder anzeigen (38)
    • idinteger

      Primärschlüssel des Standorts. Interne ID.

    • tokenstring

      Öffentlicher Token des Standorts. In Links anstelle der ID verwendet.

    • location_typestring

      Art des Ortes, zum Beispiel Raum, Halle oder Außenbereich.

    • in_contact_centerboolean

      Der Standort wird im Kontaktcenter angezeigt.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Haupttelefonnummer.

    • main_faxstring

      Haupt-Faxnummer.

    • main_emailstring

      Haupt-E-Mail-Adresse.

    • websitestring

      Website-Adresse.

    • namestring

      Name der Einheit.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • short_identifierstring

      Kurzkennung der Entität.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • slug_identifierstring

      Slug, der in URLs der Entität verwendet wird.

    • opening_hours_mondaystring

      Öffnungszeiten am Montag.

    • opening_hours_tuesdaystring

      Öffnungszeiten am Dienstag.

    • opening_hours_wednesdaystring

      Öffnungszeiten am Mittwoch.

    • opening_hours_thursdaystring

      Öffnungszeiten am Donnerstag.

    • opening_hours_fridaystring

      Öffnungszeiten am Freitag.

    • opening_hours_saturdaystring

      Öffnungszeiten am Samstag.

    • opening_hours_sundaystring

      Öffnungszeiten am Sonntag.

    • is_ui_filterboolean

      Diese Eigenschaft markiert eine Entität als Filter für das Frontend

    • unified_cat_idsobject

      IDs der vereinheitlichten Kategorien.

    • unified_cat_namesobject

      Namen der vereinheitlichten Kategorien.

  • idinteger

    Primärschlüssel der buchbaren Ressource. Interne ID.

  • tokenstring

    Öffentlicher Token der buchbaren Ressource. In Links anstelle der ID verwendet.

  • bookable_typestring

    Art der Buchungsressource, zum Beispiel Raum, Platz oder Fahrzeug.

  • floor_levelstring

    Etage, auf der das Buchbare liegt.

  • floor_sizeinteger

    Grundfläche in Quadratmetern.

  • pets_allowedboolean

    Haustiere sind erlaubt.

  • barrier_freeboolean

    Der Buchungsgegenstand ist barrierefrei.

  • cargo_volumeinteger

    Ladevolumen in Litern.

  • fuel_typestring

    Kraftstoffart des Fahrzeugs.

  • seating_capacityinteger

    Anzahl der Plätze.

  • has_wait_listboolean

    Der Buchungsgegenstand hat eine Warteliste, sobald er voll belegt ist.

  • booking_limitinteger

    Maximale Anzahl Buchungen.

  • billing_modestring

    Wie Buchungen zu diesem Buchbaren abgerechnet werden: BILLING_MODE_UPFRONT (null = vorab, Rechnung zum Buchungszeitpunkt) oder BILLING_MODE_USAGE (kostenlose Reservierung, nachgelagerte Abrechnung anhand der realen Nutzungsdaten) Auch im Standard: Die Mitglieder-App zeigt "Nutzung erfassen" nur für nutzungsabgerechnete Buchbare an.

  • max_active_bookings_per_userinteger

    Maximale Anzahl aktiver (zukünftiger, nicht stornierter) Selbstbedienungsbuchungen, die eine Person gleichzeitig für dieses buchbare Objekt halten darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.

  • max_advance_booking_hoursinteger

    Maximale Anzahl Stunden, die eine Selbstbedienungsbuchung in der Zukunft beginnen darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.

  • inventory_managedboolean

    Als Inventar erfasst (Inventar-Ausleihe): Die Geschäftsstelle übergibt den Eintrag und nimmt ihn zurück, mit Kaution und Erinnerungen. Wird nur verwendet, solange die Einstellung event_inventory_enabled aktiv ist.

  • inventory_depositnumber (float)

    Kaution pro Stück, die bei der Übergabe verlangt wird. Null = keine Kaution.

  • new_booking_only_in_blocksboolean

    Neue Buchungen sind nur in den definierten Blöcken möglich.

  • new_booking_only_in_opening_hoursboolean

    Neue Buchungen sind nur während der Öffnungszeiten möglich.

  • new_booking_only_in_self_service_opening_hoursboolean

    Neue Buchungen sind nur während der Öffnungszeiten der Selbstbedienung möglich.

  • new_booking_limit_days_beforeinteger

    Anzahl der Tage vor dem Beginn, bis zu denen neue Buchungen möglich sind.

  • new_booking_limit_stop_days_beforeinteger

    Anzahl der Tage vor dem Beginn, ab denen neue Buchungen geschlossen sind.

  • delete_booking_hours_beforeinteger

    Stunden vor Beginn, bis zu denen eine Buchung storniert werden kann.

  • block_lengthinteger

    Länge eines Buchungsblocks in Minuten.

  • new_booking_min_lengthinteger

    Mindestlänge einer neuen Buchung in Minuten.

  • new_booking_max_lengthinteger

    Maximale Länge einer neuen Buchung in Minuten.

  • require_addressboolean

    Die Adresse muss bei der Buchung eingegeben werden.

  • require_contactboolean

    Kontaktdaten müssen bei der Buchung eingegeben werden.

  • require_billingboolean

    Beim Buchen müssen Abrechnungsdaten eingegeben werden.

  • require_booking_titleboolean

    Beim Buchen muss ein Titel eingegeben werden.

  • allow_direct_billingboolean
  • require_ageboolean

    Das Alter muss bei der Buchung eingegeben werden.

  • age_groupstring

    Altersgruppe, für die die buchbare Leistung gedacht ist.

  • min_ageinteger

    Mindestalter in Jahren.

  • max_ageinteger

    Maximales Alter in Jahren.

  • age_toleranceinteger

    Jahre, um die das Alter außerhalb der Spanne liegen darf und dennoch akzeptiert wird.

  • counter_update_modestring

    Wie die Nutzungszähler des Buchbaren aktualisiert werden.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • addressstring

    Adresse als Text.

  • address_streetstring

    Straße der Adresse.

  • address_house_numberstring

    Hausnummer der Adresse.

  • address_street_levelstring

    Straße und Hausnummer der Adresse.

  • address_costring

    Care-of-Zeile der Adresse.

  • address_citystring

    Ort der Adresse.

  • address_zipstring

    Postleitzahl der Adresse.

  • address_admin_level1string

    Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

  • address_countrystring

    Ländercode der Adresse.

  • address_full_countrystring

    Vollständiger Name des Landes der Adresse.

  • address_geo_latstring

    Breitengrad der Adresse.

  • address_geo_lngstring

    Längengrad der Adresse.

  • address_external_provider_idstring

    Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • main_phonestring

    Haupttelefonnummer.

  • main_faxstring

    Haupt-Faxnummer.

  • main_emailstring

    Haupt-E-Mail-Adresse.

  • websitestring

    Website-Adresse.

  • namestring

    Name der Einheit.

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • short_identifierstring

    Kurzkennung der Entität.

  • image_urlstring

    URL des Bildes des Datensatzes.

  • slug_identifierstring

    Slug, der in URLs der Entität verwendet wird.

  • opening_hours_mondaystring

    Öffnungszeiten am Montag.

  • opening_hours_tuesdaystring

    Öffnungszeiten am Dienstag.

  • opening_hours_wednesdaystring

    Öffnungszeiten am Mittwoch.

  • opening_hours_thursdaystring

    Öffnungszeiten am Donnerstag.

  • opening_hours_fridaystring

    Öffnungszeiten am Freitag.

  • opening_hours_saturdaystring

    Öffnungszeiten am Samstag.

  • opening_hours_sundaystring

    Öffnungszeiten am Sonntag.

  • self_service_opening_hours_mondaystring

    Öffnungszeiten im Self-Service am Montag.

  • self_service_opening_hours_tuesdaystring

    Öffnungszeiten im Self-Service am Dienstag.

  • self_service_opening_hours_wednesdaystring

    Öffnungszeiten im Self-Service am Mittwoch.

  • self_service_opening_hours_thursdaystring

    Öffnungszeiten im Self-Service am Donnerstag.

  • self_service_opening_hours_fridaystring

    Öffnungszeiten im Self-Service am Freitag.

  • self_service_opening_hours_saturdaystring

    Öffnungszeiten im Self-Service am Samstag.

  • self_service_opening_hours_sundaystring

    Öffnungszeiten im Self-Service am Sonntag.

  • unified_cat_idsobject

    IDs der vereinheitlichten Kategorien.

  • unified_cat_namesobject

    Namen der vereinheitlichten Kategorien.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/event/base_bookable \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "require_booking_title": true,
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "main_phone": "+49 511 123456",
    "main_email": "lena.hartmann@example.org",
    "name": "Beispiel"
  }
]

BaseBookable neu anlegen

POST/api/event/base_bookable

Request-Body application/json

  • dataBaseBookable17
    Felder anzeigen (21)
    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Haupttelefonnummer.

    • main_faxstring

      Haupt-Faxnummer.

    • main_emailstring

      Haupt-E-Mail-Adresse.

    • websitestring

      Website-Adresse.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • image_urlstring

      URL des Bildes des Datensatzes.

    • slug_identifierstring

      Slug, der in URLs der Entität verwendet wird.

    • ucatsarray<UnifiedCategory11>

      Vereinheitlichte Kategorien des Datensatzes.

Antworten

200BaseBookable neu anlegenBaseBookable

Felder anzeigen (79)
  • ticketSeatingPlanIdinteger

    ID des Platzplans des Raums, auch für die öffentliche Serialisierung.

  • baseLocationBaseLocation4
    Felder anzeigen (38)
    • idinteger

      Primärschlüssel des Standorts. Interne ID.

    • tokenstring

      Öffentlicher Token des Standorts. In Links anstelle der ID verwendet.

    • location_typestring

      Art des Ortes, zum Beispiel Raum, Halle oder Außenbereich.

    • in_contact_centerboolean

      Der Standort wird im Kontaktcenter angezeigt.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Haupttelefonnummer.

    • main_faxstring

      Haupt-Faxnummer.

    • main_emailstring

      Haupt-E-Mail-Adresse.

    • websitestring

      Website-Adresse.

    • namestring

      Name der Einheit.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • short_identifierstring

      Kurzkennung der Entität.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • slug_identifierstring

      Slug, der in URLs der Entität verwendet wird.

    • opening_hours_mondaystring

      Öffnungszeiten am Montag.

    • opening_hours_tuesdaystring

      Öffnungszeiten am Dienstag.

    • opening_hours_wednesdaystring

      Öffnungszeiten am Mittwoch.

    • opening_hours_thursdaystring

      Öffnungszeiten am Donnerstag.

    • opening_hours_fridaystring

      Öffnungszeiten am Freitag.

    • opening_hours_saturdaystring

      Öffnungszeiten am Samstag.

    • opening_hours_sundaystring

      Öffnungszeiten am Sonntag.

    • is_ui_filterboolean

      Diese Eigenschaft markiert eine Entität als Filter für das Frontend

    • unified_cat_idsobject

      IDs der vereinheitlichten Kategorien.

    • unified_cat_namesobject

      Namen der vereinheitlichten Kategorien.

  • idinteger

    Primärschlüssel der buchbaren Ressource. Interne ID.

  • tokenstring

    Öffentlicher Token der buchbaren Ressource. In Links anstelle der ID verwendet.

  • bookable_typestring

    Art der Buchungsressource, zum Beispiel Raum, Platz oder Fahrzeug.

  • floor_levelstring

    Etage, auf der das Buchbare liegt.

  • floor_sizeinteger

    Grundfläche in Quadratmetern.

  • pets_allowedboolean

    Haustiere sind erlaubt.

  • barrier_freeboolean

    Der Buchungsgegenstand ist barrierefrei.

  • cargo_volumeinteger

    Ladevolumen in Litern.

  • fuel_typestring

    Kraftstoffart des Fahrzeugs.

  • seating_capacityinteger

    Anzahl der Plätze.

  • has_wait_listboolean

    Der Buchungsgegenstand hat eine Warteliste, sobald er voll belegt ist.

  • booking_limitinteger

    Maximale Anzahl Buchungen.

  • billing_modestring

    Wie Buchungen zu diesem Buchbaren abgerechnet werden: BILLING_MODE_UPFRONT (null = vorab, Rechnung zum Buchungszeitpunkt) oder BILLING_MODE_USAGE (kostenlose Reservierung, nachgelagerte Abrechnung anhand der realen Nutzungsdaten) Auch im Standard: Die Mitglieder-App zeigt "Nutzung erfassen" nur für nutzungsabgerechnete Buchbare an.

  • max_active_bookings_per_userinteger

    Maximale Anzahl aktiver (zukünftiger, nicht stornierter) Selbstbedienungsbuchungen, die eine Person gleichzeitig für dieses buchbare Objekt halten darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.

  • max_advance_booking_hoursinteger

    Maximale Anzahl Stunden, die eine Selbstbedienungsbuchung in der Zukunft beginnen darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.

  • inventory_managedboolean

    Als Inventar erfasst (Inventar-Ausleihe): Die Geschäftsstelle übergibt den Eintrag und nimmt ihn zurück, mit Kaution und Erinnerungen. Wird nur verwendet, solange die Einstellung event_inventory_enabled aktiv ist.

  • inventory_depositnumber (float)

    Kaution pro Stück, die bei der Übergabe verlangt wird. Null = keine Kaution.

  • new_booking_only_in_blocksboolean

    Neue Buchungen sind nur in den definierten Blöcken möglich.

  • new_booking_only_in_opening_hoursboolean

    Neue Buchungen sind nur während der Öffnungszeiten möglich.

  • new_booking_only_in_self_service_opening_hoursboolean

    Neue Buchungen sind nur während der Öffnungszeiten der Selbstbedienung möglich.

  • new_booking_limit_days_beforeinteger

    Anzahl der Tage vor dem Beginn, bis zu denen neue Buchungen möglich sind.

  • new_booking_limit_stop_days_beforeinteger

    Anzahl der Tage vor dem Beginn, ab denen neue Buchungen geschlossen sind.

  • delete_booking_hours_beforeinteger

    Stunden vor Beginn, bis zu denen eine Buchung storniert werden kann.

  • block_lengthinteger

    Länge eines Buchungsblocks in Minuten.

  • new_booking_min_lengthinteger

    Mindestlänge einer neuen Buchung in Minuten.

  • new_booking_max_lengthinteger

    Maximale Länge einer neuen Buchung in Minuten.

  • require_addressboolean

    Die Adresse muss bei der Buchung eingegeben werden.

  • require_contactboolean

    Kontaktdaten müssen bei der Buchung eingegeben werden.

  • require_billingboolean

    Beim Buchen müssen Abrechnungsdaten eingegeben werden.

  • require_booking_titleboolean

    Beim Buchen muss ein Titel eingegeben werden.

  • allow_direct_billingboolean
  • require_ageboolean

    Das Alter muss bei der Buchung eingegeben werden.

  • age_groupstring

    Altersgruppe, für die die buchbare Leistung gedacht ist.

  • min_ageinteger

    Mindestalter in Jahren.

  • max_ageinteger

    Maximales Alter in Jahren.

  • age_toleranceinteger

    Jahre, um die das Alter außerhalb der Spanne liegen darf und dennoch akzeptiert wird.

  • counter_update_modestring

    Wie die Nutzungszähler des Buchbaren aktualisiert werden.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • addressstring

    Adresse als Text.

  • address_streetstring

    Straße der Adresse.

  • address_house_numberstring

    Hausnummer der Adresse.

  • address_street_levelstring

    Straße und Hausnummer der Adresse.

  • address_costring

    Care-of-Zeile der Adresse.

  • address_citystring

    Ort der Adresse.

  • address_zipstring

    Postleitzahl der Adresse.

  • address_admin_level1string

    Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

  • address_countrystring

    Ländercode der Adresse.

  • address_full_countrystring

    Vollständiger Name des Landes der Adresse.

  • address_geo_latstring

    Breitengrad der Adresse.

  • address_geo_lngstring

    Längengrad der Adresse.

  • address_external_provider_idstring

    Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • main_phonestring

    Haupttelefonnummer.

  • main_faxstring

    Haupt-Faxnummer.

  • main_emailstring

    Haupt-E-Mail-Adresse.

  • websitestring

    Website-Adresse.

  • namestring

    Name der Einheit.

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • short_identifierstring

    Kurzkennung der Entität.

  • image_urlstring

    URL des Bildes des Datensatzes.

  • slug_identifierstring

    Slug, der in URLs der Entität verwendet wird.

  • opening_hours_mondaystring

    Öffnungszeiten am Montag.

  • opening_hours_tuesdaystring

    Öffnungszeiten am Dienstag.

  • opening_hours_wednesdaystring

    Öffnungszeiten am Mittwoch.

  • opening_hours_thursdaystring

    Öffnungszeiten am Donnerstag.

  • opening_hours_fridaystring

    Öffnungszeiten am Freitag.

  • opening_hours_saturdaystring

    Öffnungszeiten am Samstag.

  • opening_hours_sundaystring

    Öffnungszeiten am Sonntag.

  • self_service_opening_hours_mondaystring

    Öffnungszeiten im Self-Service am Montag.

  • self_service_opening_hours_tuesdaystring

    Öffnungszeiten im Self-Service am Dienstag.

  • self_service_opening_hours_wednesdaystring

    Öffnungszeiten im Self-Service am Mittwoch.

  • self_service_opening_hours_thursdaystring

    Öffnungszeiten im Self-Service am Donnerstag.

  • self_service_opening_hours_fridaystring

    Öffnungszeiten im Self-Service am Freitag.

  • self_service_opening_hours_saturdaystring

    Öffnungszeiten im Self-Service am Samstag.

  • self_service_opening_hours_sundaystring

    Öffnungszeiten im Self-Service am Sonntag.

  • unified_cat_idsobject

    IDs der vereinheitlichten Kategorien.

  • unified_cat_namesobject

    Namen der vereinheitlichten Kategorien.

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/event/base_bookable \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "main_phone": "+49 511 123456"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "require_booking_title": true,
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "name": "Beispiel"
}

Liefert ein einzelnes BaseBookable-Objekt.

GET/api/event/base_bookable/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Liefert ein einzelnes BaseBookable-Objekt.BaseBookable

Felder anzeigen (79)
  • ticketSeatingPlanIdinteger

    ID des Platzplans des Raums, auch für die öffentliche Serialisierung.

  • baseLocationBaseLocation4
    Felder anzeigen (38)
    • idinteger

      Primärschlüssel des Standorts. Interne ID.

    • tokenstring

      Öffentlicher Token des Standorts. In Links anstelle der ID verwendet.

    • location_typestring

      Art des Ortes, zum Beispiel Raum, Halle oder Außenbereich.

    • in_contact_centerboolean

      Der Standort wird im Kontaktcenter angezeigt.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Haupttelefonnummer.

    • main_faxstring

      Haupt-Faxnummer.

    • main_emailstring

      Haupt-E-Mail-Adresse.

    • websitestring

      Website-Adresse.

    • namestring

      Name der Einheit.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • short_identifierstring

      Kurzkennung der Entität.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • slug_identifierstring

      Slug, der in URLs der Entität verwendet wird.

    • opening_hours_mondaystring

      Öffnungszeiten am Montag.

    • opening_hours_tuesdaystring

      Öffnungszeiten am Dienstag.

    • opening_hours_wednesdaystring

      Öffnungszeiten am Mittwoch.

    • opening_hours_thursdaystring

      Öffnungszeiten am Donnerstag.

    • opening_hours_fridaystring

      Öffnungszeiten am Freitag.

    • opening_hours_saturdaystring

      Öffnungszeiten am Samstag.

    • opening_hours_sundaystring

      Öffnungszeiten am Sonntag.

    • is_ui_filterboolean

      Diese Eigenschaft markiert eine Entität als Filter für das Frontend

    • unified_cat_idsobject

      IDs der vereinheitlichten Kategorien.

    • unified_cat_namesobject

      Namen der vereinheitlichten Kategorien.

  • idinteger

    Primärschlüssel der buchbaren Ressource. Interne ID.

  • tokenstring

    Öffentlicher Token der buchbaren Ressource. In Links anstelle der ID verwendet.

  • bookable_typestring

    Art der Buchungsressource, zum Beispiel Raum, Platz oder Fahrzeug.

  • floor_levelstring

    Etage, auf der das Buchbare liegt.

  • floor_sizeinteger

    Grundfläche in Quadratmetern.

  • pets_allowedboolean

    Haustiere sind erlaubt.

  • barrier_freeboolean

    Der Buchungsgegenstand ist barrierefrei.

  • cargo_volumeinteger

    Ladevolumen in Litern.

  • fuel_typestring

    Kraftstoffart des Fahrzeugs.

  • seating_capacityinteger

    Anzahl der Plätze.

  • has_wait_listboolean

    Der Buchungsgegenstand hat eine Warteliste, sobald er voll belegt ist.

  • booking_limitinteger

    Maximale Anzahl Buchungen.

  • billing_modestring

    Wie Buchungen zu diesem Buchbaren abgerechnet werden: BILLING_MODE_UPFRONT (null = vorab, Rechnung zum Buchungszeitpunkt) oder BILLING_MODE_USAGE (kostenlose Reservierung, nachgelagerte Abrechnung anhand der realen Nutzungsdaten) Auch im Standard: Die Mitglieder-App zeigt "Nutzung erfassen" nur für nutzungsabgerechnete Buchbare an.

  • max_active_bookings_per_userinteger

    Maximale Anzahl aktiver (zukünftiger, nicht stornierter) Selbstbedienungsbuchungen, die eine Person gleichzeitig für dieses buchbare Objekt halten darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.

  • max_advance_booking_hoursinteger

    Maximale Anzahl Stunden, die eine Selbstbedienungsbuchung in der Zukunft beginnen darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.

  • inventory_managedboolean

    Als Inventar erfasst (Inventar-Ausleihe): Die Geschäftsstelle übergibt den Eintrag und nimmt ihn zurück, mit Kaution und Erinnerungen. Wird nur verwendet, solange die Einstellung event_inventory_enabled aktiv ist.

  • inventory_depositnumber (float)

    Kaution pro Stück, die bei der Übergabe verlangt wird. Null = keine Kaution.

  • new_booking_only_in_blocksboolean

    Neue Buchungen sind nur in den definierten Blöcken möglich.

  • new_booking_only_in_opening_hoursboolean

    Neue Buchungen sind nur während der Öffnungszeiten möglich.

  • new_booking_only_in_self_service_opening_hoursboolean

    Neue Buchungen sind nur während der Öffnungszeiten der Selbstbedienung möglich.

  • new_booking_limit_days_beforeinteger

    Anzahl der Tage vor dem Beginn, bis zu denen neue Buchungen möglich sind.

  • new_booking_limit_stop_days_beforeinteger

    Anzahl der Tage vor dem Beginn, ab denen neue Buchungen geschlossen sind.

  • delete_booking_hours_beforeinteger

    Stunden vor Beginn, bis zu denen eine Buchung storniert werden kann.

  • block_lengthinteger

    Länge eines Buchungsblocks in Minuten.

  • new_booking_min_lengthinteger

    Mindestlänge einer neuen Buchung in Minuten.

  • new_booking_max_lengthinteger

    Maximale Länge einer neuen Buchung in Minuten.

  • require_addressboolean

    Die Adresse muss bei der Buchung eingegeben werden.

  • require_contactboolean

    Kontaktdaten müssen bei der Buchung eingegeben werden.

  • require_billingboolean

    Beim Buchen müssen Abrechnungsdaten eingegeben werden.

  • require_booking_titleboolean

    Beim Buchen muss ein Titel eingegeben werden.

  • allow_direct_billingboolean
  • require_ageboolean

    Das Alter muss bei der Buchung eingegeben werden.

  • age_groupstring

    Altersgruppe, für die die buchbare Leistung gedacht ist.

  • min_ageinteger

    Mindestalter in Jahren.

  • max_ageinteger

    Maximales Alter in Jahren.

  • age_toleranceinteger

    Jahre, um die das Alter außerhalb der Spanne liegen darf und dennoch akzeptiert wird.

  • counter_update_modestring

    Wie die Nutzungszähler des Buchbaren aktualisiert werden.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • addressstring

    Adresse als Text.

  • address_streetstring

    Straße der Adresse.

  • address_house_numberstring

    Hausnummer der Adresse.

  • address_street_levelstring

    Straße und Hausnummer der Adresse.

  • address_costring

    Care-of-Zeile der Adresse.

  • address_citystring

    Ort der Adresse.

  • address_zipstring

    Postleitzahl der Adresse.

  • address_admin_level1string

    Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

  • address_countrystring

    Ländercode der Adresse.

  • address_full_countrystring

    Vollständiger Name des Landes der Adresse.

  • address_geo_latstring

    Breitengrad der Adresse.

  • address_geo_lngstring

    Längengrad der Adresse.

  • address_external_provider_idstring

    Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • main_phonestring

    Haupttelefonnummer.

  • main_faxstring

    Haupt-Faxnummer.

  • main_emailstring

    Haupt-E-Mail-Adresse.

  • websitestring

    Website-Adresse.

  • namestring

    Name der Einheit.

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • short_identifierstring

    Kurzkennung der Entität.

  • image_urlstring

    URL des Bildes des Datensatzes.

  • slug_identifierstring

    Slug, der in URLs der Entität verwendet wird.

  • opening_hours_mondaystring

    Öffnungszeiten am Montag.

  • opening_hours_tuesdaystring

    Öffnungszeiten am Dienstag.

  • opening_hours_wednesdaystring

    Öffnungszeiten am Mittwoch.

  • opening_hours_thursdaystring

    Öffnungszeiten am Donnerstag.

  • opening_hours_fridaystring

    Öffnungszeiten am Freitag.

  • opening_hours_saturdaystring

    Öffnungszeiten am Samstag.

  • opening_hours_sundaystring

    Öffnungszeiten am Sonntag.

  • self_service_opening_hours_mondaystring

    Öffnungszeiten im Self-Service am Montag.

  • self_service_opening_hours_tuesdaystring

    Öffnungszeiten im Self-Service am Dienstag.

  • self_service_opening_hours_wednesdaystring

    Öffnungszeiten im Self-Service am Mittwoch.

  • self_service_opening_hours_thursdaystring

    Öffnungszeiten im Self-Service am Donnerstag.

  • self_service_opening_hours_fridaystring

    Öffnungszeiten im Self-Service am Freitag.

  • self_service_opening_hours_saturdaystring

    Öffnungszeiten im Self-Service am Samstag.

  • self_service_opening_hours_sundaystring

    Öffnungszeiten im Self-Service am Sonntag.

  • unified_cat_idsobject

    IDs der vereinheitlichten Kategorien.

  • unified_cat_namesobject

    Namen der vereinheitlichten Kategorien.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/event/base_bookable/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "require_booking_title": true,
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "name": "Beispiel"
}

BaseBookable aktualisieren

PUT/api/event/base_bookable/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataBaseBookable17
    Felder anzeigen (21)
    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Haupttelefonnummer.

    • main_faxstring

      Haupt-Faxnummer.

    • main_emailstring

      Haupt-E-Mail-Adresse.

    • websitestring

      Website-Adresse.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • image_urlstring

      URL des Bildes des Datensatzes.

    • slug_identifierstring

      Slug, der in URLs der Entität verwendet wird.

    • ucatsarray<UnifiedCategory11>

      Vereinheitlichte Kategorien des Datensatzes.

Antworten

200BaseBookable aktualisierenBaseBookable

Felder anzeigen (79)
  • ticketSeatingPlanIdinteger

    ID des Platzplans des Raums, auch für die öffentliche Serialisierung.

  • baseLocationBaseLocation4
    Felder anzeigen (38)
    • idinteger

      Primärschlüssel des Standorts. Interne ID.

    • tokenstring

      Öffentlicher Token des Standorts. In Links anstelle der ID verwendet.

    • location_typestring

      Art des Ortes, zum Beispiel Raum, Halle oder Außenbereich.

    • in_contact_centerboolean

      Der Standort wird im Kontaktcenter angezeigt.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Haupttelefonnummer.

    • main_faxstring

      Haupt-Faxnummer.

    • main_emailstring

      Haupt-E-Mail-Adresse.

    • websitestring

      Website-Adresse.

    • namestring

      Name der Einheit.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • short_identifierstring

      Kurzkennung der Entität.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • slug_identifierstring

      Slug, der in URLs der Entität verwendet wird.

    • opening_hours_mondaystring

      Öffnungszeiten am Montag.

    • opening_hours_tuesdaystring

      Öffnungszeiten am Dienstag.

    • opening_hours_wednesdaystring

      Öffnungszeiten am Mittwoch.

    • opening_hours_thursdaystring

      Öffnungszeiten am Donnerstag.

    • opening_hours_fridaystring

      Öffnungszeiten am Freitag.

    • opening_hours_saturdaystring

      Öffnungszeiten am Samstag.

    • opening_hours_sundaystring

      Öffnungszeiten am Sonntag.

    • is_ui_filterboolean

      Diese Eigenschaft markiert eine Entität als Filter für das Frontend

    • unified_cat_idsobject

      IDs der vereinheitlichten Kategorien.

    • unified_cat_namesobject

      Namen der vereinheitlichten Kategorien.

  • idinteger

    Primärschlüssel der buchbaren Ressource. Interne ID.

  • tokenstring

    Öffentlicher Token der buchbaren Ressource. In Links anstelle der ID verwendet.

  • bookable_typestring

    Art der Buchungsressource, zum Beispiel Raum, Platz oder Fahrzeug.

  • floor_levelstring

    Etage, auf der das Buchbare liegt.

  • floor_sizeinteger

    Grundfläche in Quadratmetern.

  • pets_allowedboolean

    Haustiere sind erlaubt.

  • barrier_freeboolean

    Der Buchungsgegenstand ist barrierefrei.

  • cargo_volumeinteger

    Ladevolumen in Litern.

  • fuel_typestring

    Kraftstoffart des Fahrzeugs.

  • seating_capacityinteger

    Anzahl der Plätze.

  • has_wait_listboolean

    Der Buchungsgegenstand hat eine Warteliste, sobald er voll belegt ist.

  • booking_limitinteger

    Maximale Anzahl Buchungen.

  • billing_modestring

    Wie Buchungen zu diesem Buchbaren abgerechnet werden: BILLING_MODE_UPFRONT (null = vorab, Rechnung zum Buchungszeitpunkt) oder BILLING_MODE_USAGE (kostenlose Reservierung, nachgelagerte Abrechnung anhand der realen Nutzungsdaten) Auch im Standard: Die Mitglieder-App zeigt "Nutzung erfassen" nur für nutzungsabgerechnete Buchbare an.

  • max_active_bookings_per_userinteger

    Maximale Anzahl aktiver (zukünftiger, nicht stornierter) Selbstbedienungsbuchungen, die eine Person gleichzeitig für dieses buchbare Objekt halten darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.

  • max_advance_booking_hoursinteger

    Maximale Anzahl Stunden, die eine Selbstbedienungsbuchung in der Zukunft beginnen darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.

  • inventory_managedboolean

    Als Inventar erfasst (Inventar-Ausleihe): Die Geschäftsstelle übergibt den Eintrag und nimmt ihn zurück, mit Kaution und Erinnerungen. Wird nur verwendet, solange die Einstellung event_inventory_enabled aktiv ist.

  • inventory_depositnumber (float)

    Kaution pro Stück, die bei der Übergabe verlangt wird. Null = keine Kaution.

  • new_booking_only_in_blocksboolean

    Neue Buchungen sind nur in den definierten Blöcken möglich.

  • new_booking_only_in_opening_hoursboolean

    Neue Buchungen sind nur während der Öffnungszeiten möglich.

  • new_booking_only_in_self_service_opening_hoursboolean

    Neue Buchungen sind nur während der Öffnungszeiten der Selbstbedienung möglich.

  • new_booking_limit_days_beforeinteger

    Anzahl der Tage vor dem Beginn, bis zu denen neue Buchungen möglich sind.

  • new_booking_limit_stop_days_beforeinteger

    Anzahl der Tage vor dem Beginn, ab denen neue Buchungen geschlossen sind.

  • delete_booking_hours_beforeinteger

    Stunden vor Beginn, bis zu denen eine Buchung storniert werden kann.

  • block_lengthinteger

    Länge eines Buchungsblocks in Minuten.

  • new_booking_min_lengthinteger

    Mindestlänge einer neuen Buchung in Minuten.

  • new_booking_max_lengthinteger

    Maximale Länge einer neuen Buchung in Minuten.

  • require_addressboolean

    Die Adresse muss bei der Buchung eingegeben werden.

  • require_contactboolean

    Kontaktdaten müssen bei der Buchung eingegeben werden.

  • require_billingboolean

    Beim Buchen müssen Abrechnungsdaten eingegeben werden.

  • require_booking_titleboolean

    Beim Buchen muss ein Titel eingegeben werden.

  • allow_direct_billingboolean
  • require_ageboolean

    Das Alter muss bei der Buchung eingegeben werden.

  • age_groupstring

    Altersgruppe, für die die buchbare Leistung gedacht ist.

  • min_ageinteger

    Mindestalter in Jahren.

  • max_ageinteger

    Maximales Alter in Jahren.

  • age_toleranceinteger

    Jahre, um die das Alter außerhalb der Spanne liegen darf und dennoch akzeptiert wird.

  • counter_update_modestring

    Wie die Nutzungszähler des Buchbaren aktualisiert werden.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • addressstring

    Adresse als Text.

  • address_streetstring

    Straße der Adresse.

  • address_house_numberstring

    Hausnummer der Adresse.

  • address_street_levelstring

    Straße und Hausnummer der Adresse.

  • address_costring

    Care-of-Zeile der Adresse.

  • address_citystring

    Ort der Adresse.

  • address_zipstring

    Postleitzahl der Adresse.

  • address_admin_level1string

    Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

  • address_countrystring

    Ländercode der Adresse.

  • address_full_countrystring

    Vollständiger Name des Landes der Adresse.

  • address_geo_latstring

    Breitengrad der Adresse.

  • address_geo_lngstring

    Längengrad der Adresse.

  • address_external_provider_idstring

    Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • main_phonestring

    Haupttelefonnummer.

  • main_faxstring

    Haupt-Faxnummer.

  • main_emailstring

    Haupt-E-Mail-Adresse.

  • websitestring

    Website-Adresse.

  • namestring

    Name der Einheit.

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • short_identifierstring

    Kurzkennung der Entität.

  • image_urlstring

    URL des Bildes des Datensatzes.

  • slug_identifierstring

    Slug, der in URLs der Entität verwendet wird.

  • opening_hours_mondaystring

    Öffnungszeiten am Montag.

  • opening_hours_tuesdaystring

    Öffnungszeiten am Dienstag.

  • opening_hours_wednesdaystring

    Öffnungszeiten am Mittwoch.

  • opening_hours_thursdaystring

    Öffnungszeiten am Donnerstag.

  • opening_hours_fridaystring

    Öffnungszeiten am Freitag.

  • opening_hours_saturdaystring

    Öffnungszeiten am Samstag.

  • opening_hours_sundaystring

    Öffnungszeiten am Sonntag.

  • self_service_opening_hours_mondaystring

    Öffnungszeiten im Self-Service am Montag.

  • self_service_opening_hours_tuesdaystring

    Öffnungszeiten im Self-Service am Dienstag.

  • self_service_opening_hours_wednesdaystring

    Öffnungszeiten im Self-Service am Mittwoch.

  • self_service_opening_hours_thursdaystring

    Öffnungszeiten im Self-Service am Donnerstag.

  • self_service_opening_hours_fridaystring

    Öffnungszeiten im Self-Service am Freitag.

  • self_service_opening_hours_saturdaystring

    Öffnungszeiten im Self-Service am Samstag.

  • self_service_opening_hours_sundaystring

    Öffnungszeiten im Self-Service am Sonntag.

  • unified_cat_idsobject

    IDs der vereinheitlichten Kategorien.

  • unified_cat_namesobject

    Namen der vereinheitlichten Kategorien.

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/event/base_bookable/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "main_phone": "+49 511 123456"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "require_booking_title": true,
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "name": "Beispiel"
}

BaseBookable aktualisieren

PATCH/api/event/base_bookable/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataBaseBookable17
    Felder anzeigen (21)
    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Haupttelefonnummer.

    • main_faxstring

      Haupt-Faxnummer.

    • main_emailstring

      Haupt-E-Mail-Adresse.

    • websitestring

      Website-Adresse.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • image_urlstring

      URL des Bildes des Datensatzes.

    • slug_identifierstring

      Slug, der in URLs der Entität verwendet wird.

    • ucatsarray<UnifiedCategory11>

      Vereinheitlichte Kategorien des Datensatzes.

Antworten

200BaseBookable aktualisierenBaseBookable

Felder anzeigen (79)
  • ticketSeatingPlanIdinteger

    ID des Platzplans des Raums, auch für die öffentliche Serialisierung.

  • baseLocationBaseLocation4
    Felder anzeigen (38)
    • idinteger

      Primärschlüssel des Standorts. Interne ID.

    • tokenstring

      Öffentlicher Token des Standorts. In Links anstelle der ID verwendet.

    • location_typestring

      Art des Ortes, zum Beispiel Raum, Halle oder Außenbereich.

    • in_contact_centerboolean

      Der Standort wird im Kontaktcenter angezeigt.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Haupttelefonnummer.

    • main_faxstring

      Haupt-Faxnummer.

    • main_emailstring

      Haupt-E-Mail-Adresse.

    • websitestring

      Website-Adresse.

    • namestring

      Name der Einheit.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • short_identifierstring

      Kurzkennung der Entität.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • slug_identifierstring

      Slug, der in URLs der Entität verwendet wird.

    • opening_hours_mondaystring

      Öffnungszeiten am Montag.

    • opening_hours_tuesdaystring

      Öffnungszeiten am Dienstag.

    • opening_hours_wednesdaystring

      Öffnungszeiten am Mittwoch.

    • opening_hours_thursdaystring

      Öffnungszeiten am Donnerstag.

    • opening_hours_fridaystring

      Öffnungszeiten am Freitag.

    • opening_hours_saturdaystring

      Öffnungszeiten am Samstag.

    • opening_hours_sundaystring

      Öffnungszeiten am Sonntag.

    • is_ui_filterboolean

      Diese Eigenschaft markiert eine Entität als Filter für das Frontend

    • unified_cat_idsobject

      IDs der vereinheitlichten Kategorien.

    • unified_cat_namesobject

      Namen der vereinheitlichten Kategorien.

  • idinteger

    Primärschlüssel der buchbaren Ressource. Interne ID.

  • tokenstring

    Öffentlicher Token der buchbaren Ressource. In Links anstelle der ID verwendet.

  • bookable_typestring

    Art der Buchungsressource, zum Beispiel Raum, Platz oder Fahrzeug.

  • floor_levelstring

    Etage, auf der das Buchbare liegt.

  • floor_sizeinteger

    Grundfläche in Quadratmetern.

  • pets_allowedboolean

    Haustiere sind erlaubt.

  • barrier_freeboolean

    Der Buchungsgegenstand ist barrierefrei.

  • cargo_volumeinteger

    Ladevolumen in Litern.

  • fuel_typestring

    Kraftstoffart des Fahrzeugs.

  • seating_capacityinteger

    Anzahl der Plätze.

  • has_wait_listboolean

    Der Buchungsgegenstand hat eine Warteliste, sobald er voll belegt ist.

  • booking_limitinteger

    Maximale Anzahl Buchungen.

  • billing_modestring

    Wie Buchungen zu diesem Buchbaren abgerechnet werden: BILLING_MODE_UPFRONT (null = vorab, Rechnung zum Buchungszeitpunkt) oder BILLING_MODE_USAGE (kostenlose Reservierung, nachgelagerte Abrechnung anhand der realen Nutzungsdaten) Auch im Standard: Die Mitglieder-App zeigt "Nutzung erfassen" nur für nutzungsabgerechnete Buchbare an.

  • max_active_bookings_per_userinteger

    Maximale Anzahl aktiver (zukünftiger, nicht stornierter) Selbstbedienungsbuchungen, die eine Person gleichzeitig für dieses buchbare Objekt halten darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.

  • max_advance_booking_hoursinteger

    Maximale Anzahl Stunden, die eine Selbstbedienungsbuchung in der Zukunft beginnen darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.

  • inventory_managedboolean

    Als Inventar erfasst (Inventar-Ausleihe): Die Geschäftsstelle übergibt den Eintrag und nimmt ihn zurück, mit Kaution und Erinnerungen. Wird nur verwendet, solange die Einstellung event_inventory_enabled aktiv ist.

  • inventory_depositnumber (float)

    Kaution pro Stück, die bei der Übergabe verlangt wird. Null = keine Kaution.

  • new_booking_only_in_blocksboolean

    Neue Buchungen sind nur in den definierten Blöcken möglich.

  • new_booking_only_in_opening_hoursboolean

    Neue Buchungen sind nur während der Öffnungszeiten möglich.

  • new_booking_only_in_self_service_opening_hoursboolean

    Neue Buchungen sind nur während der Öffnungszeiten der Selbstbedienung möglich.

  • new_booking_limit_days_beforeinteger

    Anzahl der Tage vor dem Beginn, bis zu denen neue Buchungen möglich sind.

  • new_booking_limit_stop_days_beforeinteger

    Anzahl der Tage vor dem Beginn, ab denen neue Buchungen geschlossen sind.

  • delete_booking_hours_beforeinteger

    Stunden vor Beginn, bis zu denen eine Buchung storniert werden kann.

  • block_lengthinteger

    Länge eines Buchungsblocks in Minuten.

  • new_booking_min_lengthinteger

    Mindestlänge einer neuen Buchung in Minuten.

  • new_booking_max_lengthinteger

    Maximale Länge einer neuen Buchung in Minuten.

  • require_addressboolean

    Die Adresse muss bei der Buchung eingegeben werden.

  • require_contactboolean

    Kontaktdaten müssen bei der Buchung eingegeben werden.

  • require_billingboolean

    Beim Buchen müssen Abrechnungsdaten eingegeben werden.

  • require_booking_titleboolean

    Beim Buchen muss ein Titel eingegeben werden.

  • allow_direct_billingboolean
  • require_ageboolean

    Das Alter muss bei der Buchung eingegeben werden.

  • age_groupstring

    Altersgruppe, für die die buchbare Leistung gedacht ist.

  • min_ageinteger

    Mindestalter in Jahren.

  • max_ageinteger

    Maximales Alter in Jahren.

  • age_toleranceinteger

    Jahre, um die das Alter außerhalb der Spanne liegen darf und dennoch akzeptiert wird.

  • counter_update_modestring

    Wie die Nutzungszähler des Buchbaren aktualisiert werden.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • addressstring

    Adresse als Text.

  • address_streetstring

    Straße der Adresse.

  • address_house_numberstring

    Hausnummer der Adresse.

  • address_street_levelstring

    Straße und Hausnummer der Adresse.

  • address_costring

    Care-of-Zeile der Adresse.

  • address_citystring

    Ort der Adresse.

  • address_zipstring

    Postleitzahl der Adresse.

  • address_admin_level1string

    Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

  • address_countrystring

    Ländercode der Adresse.

  • address_full_countrystring

    Vollständiger Name des Landes der Adresse.

  • address_geo_latstring

    Breitengrad der Adresse.

  • address_geo_lngstring

    Längengrad der Adresse.

  • address_external_provider_idstring

    Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • main_phonestring

    Haupttelefonnummer.

  • main_faxstring

    Haupt-Faxnummer.

  • main_emailstring

    Haupt-E-Mail-Adresse.

  • websitestring

    Website-Adresse.

  • namestring

    Name der Einheit.

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • short_identifierstring

    Kurzkennung der Entität.

  • image_urlstring

    URL des Bildes des Datensatzes.

  • slug_identifierstring

    Slug, der in URLs der Entität verwendet wird.

  • opening_hours_mondaystring

    Öffnungszeiten am Montag.

  • opening_hours_tuesdaystring

    Öffnungszeiten am Dienstag.

  • opening_hours_wednesdaystring

    Öffnungszeiten am Mittwoch.

  • opening_hours_thursdaystring

    Öffnungszeiten am Donnerstag.

  • opening_hours_fridaystring

    Öffnungszeiten am Freitag.

  • opening_hours_saturdaystring

    Öffnungszeiten am Samstag.

  • opening_hours_sundaystring

    Öffnungszeiten am Sonntag.

  • self_service_opening_hours_mondaystring

    Öffnungszeiten im Self-Service am Montag.

  • self_service_opening_hours_tuesdaystring

    Öffnungszeiten im Self-Service am Dienstag.

  • self_service_opening_hours_wednesdaystring

    Öffnungszeiten im Self-Service am Mittwoch.

  • self_service_opening_hours_thursdaystring

    Öffnungszeiten im Self-Service am Donnerstag.

  • self_service_opening_hours_fridaystring

    Öffnungszeiten im Self-Service am Freitag.

  • self_service_opening_hours_saturdaystring

    Öffnungszeiten im Self-Service am Samstag.

  • self_service_opening_hours_sundaystring

    Öffnungszeiten im Self-Service am Sonntag.

  • unified_cat_idsobject

    IDs der vereinheitlichten Kategorien.

  • unified_cat_namesobject

    Namen der vereinheitlichten Kategorien.

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/event/base_bookable/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "main_phone": "+49 511 123456"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "require_booking_title": true,
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163",
  "address_country": "DE",
  "address_full_country": "DE",
  "main_phone": "+49 511 123456",
  "main_email": "lena.hartmann@example.org",
  "name": "Beispiel"
}

Liefert eine Liste der BaseBookable-Objekte mit dem angegebenen Self-Service-Zugriffs-Scope.

GET/api/event/base_bookable_for_self_service_scope/{scope}

Pfad-Parameter

scopePflichtstring

Query-Parameter

namestringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE
tokenstringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE
baseLocationstringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE
bookableTypestringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE
slugIdentifierstringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE
addressStreetLevelstringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE
addressCitystringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE
addressZipstringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE
addressCountrystringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE
addressGeoLatstringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE
addressGeoLngstringErfordert Zugriffsrecht: PUBLIC, LOGGED_IN, LOGGED_IN_EXPLICIT, C1, SCOPE
idinteger
deletedbooleanDiese Eigenschaft markiert eine Entität als gelöscht / archiviert | Benötigtes Zugriffsrecht: SCOPE
billingModestringWie Buchungen zu diesem Buchbaren abgerechnet werden: BILLING_MODE_UPFRONT (null = vorab, Rechnung zum Buchungszeitpunkt) oder BILLING_MODE_USAGE (kostenlose Reservierung, nachgelagerte Abrechnung anhand der realen Nutzungsdaten) Auch im Standard: Die Mitglieder-App zeigt "Nutzung erfassen" nur für nutzungsabgerechnete Buchbare an. | Benötigt Zugriffsrecht: SCOPE
usageBillingIntervalstringAbrechnungsintervall für BILLING_MODE_USAGE: USAGE_BILLING_INTERVAL_PER_BOOKING oder USAGE_BILLING_INTERVAL_MONTHLY. Null = Einstellung event_real_usage_billing_mode verwenden.
maxActiveBookingsPerUserstringMaximale Anzahl aktiver (zukünftiger, nicht stornierter) Selbstbedienungsbuchungen, die eine Person gleichzeitig für dieses buchbare Objekt halten darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt. | Benötigt Zugriffs-Tag: SCOPE
maxAdvanceBookingHoursstringMaximale Anzahl Stunden, die eine Selbstbedienungsbuchung in der Zukunft beginnen darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt. | Benötigt Zugriffs-Tag: SCOPE
inventoryManagedbooleanAls Inventar erfasst (Inventar-Ausleihe): Die Geschäftsstelle übergibt den Eintrag und nimmt ihn zurück, mit Kaution und Erinnerungen. Wird nur verwendet, solange die Einstellung event_inventory_enabled aktiv ist. | Benötigt Zugriffs-Tag: SCOPE
inventoryNumberstringInventarnummer des Eintrags (Inventarnummer). | Benötigt Zugriffs-Tag: SCOPE
createdstring
searchStringstringText, nach dem in der Liste gesucht wird
orderFieldNamestringName des Bestellfelds
orderFieldSortstringSortiermodusErlaubt: DESCASC
pageintegerSeite der Liste
pageSizeintegerAnzahl der Einträge je Seite
withMaxPageNumberstringgibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Liefert eine Liste der BaseBookable-Objekte mit dem angegebenen Self-Service-Zugriffs-Scope.array<BaseBookable>

Felder anzeigen (79)
  • ticketSeatingPlanIdinteger

    ID des Platzplans des Raums, auch für die öffentliche Serialisierung.

  • baseLocationBaseLocation4
    Felder anzeigen (38)
    • idinteger

      Primärschlüssel des Standorts. Interne ID.

    • tokenstring

      Öffentlicher Token des Standorts. In Links anstelle der ID verwendet.

    • location_typestring

      Art des Ortes, zum Beispiel Raum, Halle oder Außenbereich.

    • in_contact_centerboolean

      Der Standort wird im Kontaktcenter angezeigt.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Haupttelefonnummer.

    • main_faxstring

      Haupt-Faxnummer.

    • main_emailstring

      Haupt-E-Mail-Adresse.

    • websitestring

      Website-Adresse.

    • namestring

      Name der Einheit.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • short_identifierstring

      Kurzkennung der Entität.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • slug_identifierstring

      Slug, der in URLs der Entität verwendet wird.

    • opening_hours_mondaystring

      Öffnungszeiten am Montag.

    • opening_hours_tuesdaystring

      Öffnungszeiten am Dienstag.

    • opening_hours_wednesdaystring

      Öffnungszeiten am Mittwoch.

    • opening_hours_thursdaystring

      Öffnungszeiten am Donnerstag.

    • opening_hours_fridaystring

      Öffnungszeiten am Freitag.

    • opening_hours_saturdaystring

      Öffnungszeiten am Samstag.

    • opening_hours_sundaystring

      Öffnungszeiten am Sonntag.

    • is_ui_filterboolean

      Diese Eigenschaft markiert eine Entität als Filter für das Frontend

    • unified_cat_idsobject

      IDs der vereinheitlichten Kategorien.

    • unified_cat_namesobject

      Namen der vereinheitlichten Kategorien.

  • idinteger

    Primärschlüssel der buchbaren Ressource. Interne ID.

  • tokenstring

    Öffentlicher Token der buchbaren Ressource. In Links anstelle der ID verwendet.

  • bookable_typestring

    Art der Buchungsressource, zum Beispiel Raum, Platz oder Fahrzeug.

  • floor_levelstring

    Etage, auf der das Buchbare liegt.

  • floor_sizeinteger

    Grundfläche in Quadratmetern.

  • pets_allowedboolean

    Haustiere sind erlaubt.

  • barrier_freeboolean

    Der Buchungsgegenstand ist barrierefrei.

  • cargo_volumeinteger

    Ladevolumen in Litern.

  • fuel_typestring

    Kraftstoffart des Fahrzeugs.

  • seating_capacityinteger

    Anzahl der Plätze.

  • has_wait_listboolean

    Der Buchungsgegenstand hat eine Warteliste, sobald er voll belegt ist.

  • booking_limitinteger

    Maximale Anzahl Buchungen.

  • billing_modestring

    Wie Buchungen zu diesem Buchbaren abgerechnet werden: BILLING_MODE_UPFRONT (null = vorab, Rechnung zum Buchungszeitpunkt) oder BILLING_MODE_USAGE (kostenlose Reservierung, nachgelagerte Abrechnung anhand der realen Nutzungsdaten) Auch im Standard: Die Mitglieder-App zeigt "Nutzung erfassen" nur für nutzungsabgerechnete Buchbare an.

  • max_active_bookings_per_userinteger

    Maximale Anzahl aktiver (zukünftiger, nicht stornierter) Selbstbedienungsbuchungen, die eine Person gleichzeitig für dieses buchbare Objekt halten darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.

  • max_advance_booking_hoursinteger

    Maximale Anzahl Stunden, die eine Selbstbedienungsbuchung in der Zukunft beginnen darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.

  • inventory_managedboolean

    Als Inventar erfasst (Inventar-Ausleihe): Die Geschäftsstelle übergibt den Eintrag und nimmt ihn zurück, mit Kaution und Erinnerungen. Wird nur verwendet, solange die Einstellung event_inventory_enabled aktiv ist.

  • inventory_depositnumber (float)

    Kaution pro Stück, die bei der Übergabe verlangt wird. Null = keine Kaution.

  • new_booking_only_in_blocksboolean

    Neue Buchungen sind nur in den definierten Blöcken möglich.

  • new_booking_only_in_opening_hoursboolean

    Neue Buchungen sind nur während der Öffnungszeiten möglich.

  • new_booking_only_in_self_service_opening_hoursboolean

    Neue Buchungen sind nur während der Öffnungszeiten der Selbstbedienung möglich.

  • new_booking_limit_days_beforeinteger

    Anzahl der Tage vor dem Beginn, bis zu denen neue Buchungen möglich sind.

  • new_booking_limit_stop_days_beforeinteger

    Anzahl der Tage vor dem Beginn, ab denen neue Buchungen geschlossen sind.

  • delete_booking_hours_beforeinteger

    Stunden vor Beginn, bis zu denen eine Buchung storniert werden kann.

  • block_lengthinteger

    Länge eines Buchungsblocks in Minuten.

  • new_booking_min_lengthinteger

    Mindestlänge einer neuen Buchung in Minuten.

  • new_booking_max_lengthinteger

    Maximale Länge einer neuen Buchung in Minuten.

  • require_addressboolean

    Die Adresse muss bei der Buchung eingegeben werden.

  • require_contactboolean

    Kontaktdaten müssen bei der Buchung eingegeben werden.

  • require_billingboolean

    Beim Buchen müssen Abrechnungsdaten eingegeben werden.

  • require_booking_titleboolean

    Beim Buchen muss ein Titel eingegeben werden.

  • allow_direct_billingboolean
  • require_ageboolean

    Das Alter muss bei der Buchung eingegeben werden.

  • age_groupstring

    Altersgruppe, für die die buchbare Leistung gedacht ist.

  • min_ageinteger

    Mindestalter in Jahren.

  • max_ageinteger

    Maximales Alter in Jahren.

  • age_toleranceinteger

    Jahre, um die das Alter außerhalb der Spanne liegen darf und dennoch akzeptiert wird.

  • counter_update_modestring

    Wie die Nutzungszähler des Buchbaren aktualisiert werden.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • addressstring

    Adresse als Text.

  • address_streetstring

    Straße der Adresse.

  • address_house_numberstring

    Hausnummer der Adresse.

  • address_street_levelstring

    Straße und Hausnummer der Adresse.

  • address_costring

    Care-of-Zeile der Adresse.

  • address_citystring

    Ort der Adresse.

  • address_zipstring

    Postleitzahl der Adresse.

  • address_admin_level1string

    Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

  • address_countrystring

    Ländercode der Adresse.

  • address_full_countrystring

    Vollständiger Name des Landes der Adresse.

  • address_geo_latstring

    Breitengrad der Adresse.

  • address_geo_lngstring

    Längengrad der Adresse.

  • address_external_provider_idstring

    Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • main_phonestring

    Haupttelefonnummer.

  • main_faxstring

    Haupt-Faxnummer.

  • main_emailstring

    Haupt-E-Mail-Adresse.

  • websitestring

    Website-Adresse.

  • namestring

    Name der Einheit.

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • short_identifierstring

    Kurzkennung der Entität.

  • image_urlstring

    URL des Bildes des Datensatzes.

  • slug_identifierstring

    Slug, der in URLs der Entität verwendet wird.

  • opening_hours_mondaystring

    Öffnungszeiten am Montag.

  • opening_hours_tuesdaystring

    Öffnungszeiten am Dienstag.

  • opening_hours_wednesdaystring

    Öffnungszeiten am Mittwoch.

  • opening_hours_thursdaystring

    Öffnungszeiten am Donnerstag.

  • opening_hours_fridaystring

    Öffnungszeiten am Freitag.

  • opening_hours_saturdaystring

    Öffnungszeiten am Samstag.

  • opening_hours_sundaystring

    Öffnungszeiten am Sonntag.

  • self_service_opening_hours_mondaystring

    Öffnungszeiten im Self-Service am Montag.

  • self_service_opening_hours_tuesdaystring

    Öffnungszeiten im Self-Service am Dienstag.

  • self_service_opening_hours_wednesdaystring

    Öffnungszeiten im Self-Service am Mittwoch.

  • self_service_opening_hours_thursdaystring

    Öffnungszeiten im Self-Service am Donnerstag.

  • self_service_opening_hours_fridaystring

    Öffnungszeiten im Self-Service am Freitag.

  • self_service_opening_hours_saturdaystring

    Öffnungszeiten im Self-Service am Samstag.

  • self_service_opening_hours_sundaystring

    Öffnungszeiten im Self-Service am Sonntag.

  • unified_cat_idsobject

    IDs der vereinheitlichten Kategorien.

  • unified_cat_namesobject

    Namen der vereinheitlichten Kategorien.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/event/base_bookable_for_self_service_scope/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "require_booking_title": true,
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "main_phone": "+49 511 123456",
    "main_email": "lena.hartmann@example.org",
    "name": "Beispiel"
  }
]

Liefert einen Kalender-Feed für ein buchbares Objekt.

GET/api/event/base_bookable_calendar/{identifier}/{anonymized}

Pfad-Parameter

identifierPflichtstring
anonymizedPflichtstring

Antworten

default

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/event/base_bookable_calendar/42/42 \
  --header 'x-iw-jwt-token: <TOKEN>'