Zum Inhalt springen
Developer

BookableType

Orte und Buchungen5 EndpunkteEvent / BookableType

Diese Methode liefert alle BaseBookableBookableType-Objekte

GET/api/event/bookable_type

Query-Parameter

idstring
deletedbooleanDiese Eigenschaft markiert eine Entität als gelöscht / archiviert | Benötigtes Zugriffsrecht: SCOPE
namestring
shortNamestringKurzname für kompakte Oberflächenbeschriftungen (z. B. Kalender, Badges). | Benötigt Zugriffs-Tag: SCOPE
viewOrderinteger
menuNamestring
menuIconstring
showAdminMenuboolean
showAdminCalendarboolean
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 BaseBookableBookableType-Objekte.array<BaseBookableBookableType>

Felder anzeigen (11)
  • idstring

    Kennung des buchbaren Typs. Zum Beispiel Raum oder Fahrzeug.

  • short_namestring

    Kurzname für kompakte Oberflächenbeschriftungen (z. B. Kalender, Badges).

  • namestring

    Name des buchbaren Typs.

  • view_orderinteger

    Sortierreihenfolge des Buchbar-Typs in Listen.

  • menu_namestring

    Name des Menüeintrags für den buchbaren Typ.

  • menu_iconstring

    Symbol des Menüeintrags für den Buchbar-Typ.

  • show_admin_menuboolean

    Den Buchbar-Typ im Admin-Menü anzeigen.

  • show_admin_calendarboolean

    Den Buchbar-Typ im Admin-Kalender anzeigen.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • deletedboolean

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

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/event/bookable_type \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": "42",
    "short_name": "Beispiel",
    "name": "Beispiel",
    "menu_name": "Beispiel",
    "view_order": 1,
    "menu_icon": "string",
    "show_admin_menu": true,
    "show_admin_calendar": true,
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  }
]

BaseBookableBookableType neu anlegen

POST/api/event/bookable_type

Request-Body application/json

  • dataBaseBookableBookableType2
    Felder anzeigen (1)
    • deletedboolean

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

Antworten

200BaseBookableBookableType neu anlegenBaseBookableBookableType

Felder anzeigen (11)
  • idstring

    Kennung des buchbaren Typs. Zum Beispiel Raum oder Fahrzeug.

  • short_namestring

    Kurzname für kompakte Oberflächenbeschriftungen (z. B. Kalender, Badges).

  • namestring

    Name des buchbaren Typs.

  • view_orderinteger

    Sortierreihenfolge des Buchbar-Typs in Listen.

  • menu_namestring

    Name des Menüeintrags für den buchbaren Typ.

  • menu_iconstring

    Symbol des Menüeintrags für den Buchbar-Typ.

  • show_admin_menuboolean

    Den Buchbar-Typ im Admin-Menü anzeigen.

  • show_admin_calendarboolean

    Den Buchbar-Typ im Admin-Kalender anzeigen.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • deletedboolean

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

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/event/bookable_type \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "deleted": true
  }
}
'
Antwort 200 application/json
{
  "id": "42",
  "short_name": "Beispiel",
  "name": "Beispiel",
  "menu_name": "Beispiel",
  "view_order": 1,
  "menu_icon": "string",
  "show_admin_menu": true,
  "show_admin_calendar": true,
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

Diese Methode liefert einen einzelnen BaseBookableBookableType mit der angegebenen ID

GET/api/event/bookable_type/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Liefert ein einzelnes BaseBookableBookableType-Objekt.BaseBookableBookableType

Felder anzeigen (11)
  • idstring

    Kennung des buchbaren Typs. Zum Beispiel Raum oder Fahrzeug.

  • short_namestring

    Kurzname für kompakte Oberflächenbeschriftungen (z. B. Kalender, Badges).

  • namestring

    Name des buchbaren Typs.

  • view_orderinteger

    Sortierreihenfolge des Buchbar-Typs in Listen.

  • menu_namestring

    Name des Menüeintrags für den buchbaren Typ.

  • menu_iconstring

    Symbol des Menüeintrags für den Buchbar-Typ.

  • show_admin_menuboolean

    Den Buchbar-Typ im Admin-Menü anzeigen.

  • show_admin_calendarboolean

    Den Buchbar-Typ im Admin-Kalender anzeigen.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • deletedboolean

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

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/event/bookable_type/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": "42",
  "short_name": "Beispiel",
  "name": "Beispiel",
  "menu_name": "Beispiel",
  "view_order": 1,
  "menu_icon": "string",
  "show_admin_menu": true,
  "show_admin_calendar": true,
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

BaseBookableBookableType aktualisieren

PUT/api/event/bookable_type/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataBaseBookableBookableType2
    Felder anzeigen (1)
    • deletedboolean

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

Antworten

200BaseBookableBookableType aktualisierenBaseBookableBookableType

Felder anzeigen (11)
  • idstring

    Kennung des buchbaren Typs. Zum Beispiel Raum oder Fahrzeug.

  • short_namestring

    Kurzname für kompakte Oberflächenbeschriftungen (z. B. Kalender, Badges).

  • namestring

    Name des buchbaren Typs.

  • view_orderinteger

    Sortierreihenfolge des Buchbar-Typs in Listen.

  • menu_namestring

    Name des Menüeintrags für den buchbaren Typ.

  • menu_iconstring

    Symbol des Menüeintrags für den Buchbar-Typ.

  • show_admin_menuboolean

    Den Buchbar-Typ im Admin-Menü anzeigen.

  • show_admin_calendarboolean

    Den Buchbar-Typ im Admin-Kalender anzeigen.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • deletedboolean

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

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/event/bookable_type/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "deleted": true
  }
}
'
Antwort 200 application/json
{
  "id": "42",
  "short_name": "Beispiel",
  "name": "Beispiel",
  "menu_name": "Beispiel",
  "view_order": 1,
  "menu_icon": "string",
  "show_admin_menu": true,
  "show_admin_calendar": true,
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

BaseBookableBookableType aktualisieren

PATCH/api/event/bookable_type/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataBaseBookableBookableType2
    Felder anzeigen (1)
    • deletedboolean

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

Antworten

200BaseBookableBookableType aktualisierenBaseBookableBookableType

Felder anzeigen (11)
  • idstring

    Kennung des buchbaren Typs. Zum Beispiel Raum oder Fahrzeug.

  • short_namestring

    Kurzname für kompakte Oberflächenbeschriftungen (z. B. Kalender, Badges).

  • namestring

    Name des buchbaren Typs.

  • view_orderinteger

    Sortierreihenfolge des Buchbar-Typs in Listen.

  • menu_namestring

    Name des Menüeintrags für den buchbaren Typ.

  • menu_iconstring

    Symbol des Menüeintrags für den Buchbar-Typ.

  • show_admin_menuboolean

    Den Buchbar-Typ im Admin-Menü anzeigen.

  • show_admin_calendarboolean

    Den Buchbar-Typ im Admin-Kalender anzeigen.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • deletedboolean

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

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/event/bookable_type/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "deleted": true
  }
}
'
Antwort 200 application/json
{
  "id": "42",
  "short_name": "Beispiel",
  "name": "Beispiel",
  "menu_name": "Beispiel",
  "view_order": 1,
  "menu_icon": "string",
  "show_admin_menu": true,
  "show_admin_calendar": true,
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}