Zum Inhalt springen
Developer

BaseLocationPlanItem

Orte und Buchungen5 EndpunkteEvent / BaseLocationPlanItem

Liefert eine Liste der BaseLocationPlanItem-Objekte.

GET/api/event/base_location_plan_item

Query-Parameter

idinteger
deletedbooleanDiese Eigenschaft markiert eine Entität als gelöscht / archiviert | Benötigtes Zugriffsrecht: SCOPE | Standardwert: false
tokenstring
planstring
baseBookablestring
itemTypestring
shapestring
createdstring
updatedstring
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 BaseLocationPlanItem-Objekte.array<BaseLocationPlanItem>

Felder anzeigen (25)
  • planinteger
  • displayLabelstring

    Auf dem Plan angezeigte Bezeichnung: die manuelle Bezeichnung hat Vorrang, sonst der gespeicherte Name des buchbaren Eintrags.

  • idinteger

    Primärschlüssel der Planposition. Interne ID.

  • tokenstring

    Öffentlicher Token der Planposition. Anstelle der ID verwendet.

  • item_typestring

    Art des Gegenstands, zum Beispiel Sitz, Tisch oder Etikett.

  • shapestring

    Form der Position im Plan.

  • pos_xnumber (float)

    Linker Rand, normiert 0.0 - 1.0

  • pos_ynumber (float)

    Obere Kante, normalisiert 0.0 - 1.0

  • widthnumber (float)

    Breite der Position in Planeinheiten.

  • heightnumber (float)

    Höhe des Elements in Planeinheiten.

  • rotationnumber (float)

    Drehung der Position in Grad.

  • z_indexinteger

    Stapelreihenfolge der Position im Plan.

  • labelstring

    Überschreibt den Buchbar-Namen im Plan.

  • iconstring

    Symbol, das auf dem Element angezeigt wird.

  • show_labelboolean

    Die Bezeichnung der Position anzeigen.

  • show_statusboolean

    Den Status der Position anzeigen.

  • show_nextboolean

    Die nächste Buchung der Position anzeigen.

  • seat_rowstring

    Platz: Reihe („5“, „B“), wie auf dem Ticket aufgedruckt.

  • seat_numberstring

    Platz: Nummer innerhalb der Reihe.

  • seat_zonestring

    Platz: Preiszone („A“, „Loge“). Auf ihm kann eine Ticketkategorie der Veranstaltung mit derselben PredefinedBillingItem::ticketSeatZone gebucht werden; ohne Zone darf jede Kategorie gebucht werden.

  • 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

  • colorstring

    Hintergrundfarbe als Hexwert.

  • fg_colorstring

    Vordergrundfarbe als Hex-Wert.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/event/base_location_plan_item \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "color": "#3f5efb",
    "fg_color": "#3f5efb",
    "plan": 1,
    "displayLabel": "string",
    "token": "string",
    "item_type": "string",
    "shape": "string",
    "pos_x": 1.5,
    "pos_y": 1.5
  }
]

BaseLocationPlanItem neu anlegen

POST/api/event/base_location_plan_item

Request-Body application/json

  • dataBaseLocationPlanItem2
    Felder anzeigen (17)
    • item_typestring

      Art des Gegenstands, zum Beispiel Sitz, Tisch oder Etikett.

    • shapestring

      Form der Position im Plan.

    • pos_xnumber (float)

      Linker Rand, normiert 0.0 - 1.0

    • pos_ynumber (float)

      Obere Kante, normalisiert 0.0 - 1.0

    • widthnumber (float)

      Breite der Position in Planeinheiten.

    • heightnumber (float)

      Höhe des Elements in Planeinheiten.

    • rotationnumber (float)

      Drehung der Position in Grad.

    • z_indexinteger

      Stapelreihenfolge der Position im Plan.

    • labelstring

      Überschreibt den Buchbar-Namen im Plan.

    • iconstring

      Symbol, das auf dem Element angezeigt wird.

    • show_labelboolean

      Die Bezeichnung der Position anzeigen.

    • show_statusboolean

      Den Status der Position anzeigen.

    • show_nextboolean

      Die nächste Buchung der Position anzeigen.

    • seat_rowstring

      Platz: Reihe („5“, „B“), wie auf dem Ticket aufgedruckt.

    • seat_numberstring

      Platz: Nummer innerhalb der Reihe.

    • seat_zonestring

      Platz: Preiszone („A“, „Loge“). Auf ihm kann eine Ticketkategorie der Veranstaltung mit derselben PredefinedBillingItem::ticketSeatZone gebucht werden; ohne Zone darf jede Kategorie gebucht werden.

    • deletedboolean

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

Antworten

200BaseLocationPlanItem neu anlegenBaseLocationPlanItem

Felder anzeigen (25)
  • planinteger
  • displayLabelstring

    Auf dem Plan angezeigte Bezeichnung: die manuelle Bezeichnung hat Vorrang, sonst der gespeicherte Name des buchbaren Eintrags.

  • idinteger

    Primärschlüssel der Planposition. Interne ID.

  • tokenstring

    Öffentlicher Token der Planposition. Anstelle der ID verwendet.

  • item_typestring

    Art des Gegenstands, zum Beispiel Sitz, Tisch oder Etikett.

  • shapestring

    Form der Position im Plan.

  • pos_xnumber (float)

    Linker Rand, normiert 0.0 - 1.0

  • pos_ynumber (float)

    Obere Kante, normalisiert 0.0 - 1.0

  • widthnumber (float)

    Breite der Position in Planeinheiten.

  • heightnumber (float)

    Höhe des Elements in Planeinheiten.

  • rotationnumber (float)

    Drehung der Position in Grad.

  • z_indexinteger

    Stapelreihenfolge der Position im Plan.

  • labelstring

    Überschreibt den Buchbar-Namen im Plan.

  • iconstring

    Symbol, das auf dem Element angezeigt wird.

  • show_labelboolean

    Die Bezeichnung der Position anzeigen.

  • show_statusboolean

    Den Status der Position anzeigen.

  • show_nextboolean

    Die nächste Buchung der Position anzeigen.

  • seat_rowstring

    Platz: Reihe („5“, „B“), wie auf dem Ticket aufgedruckt.

  • seat_numberstring

    Platz: Nummer innerhalb der Reihe.

  • seat_zonestring

    Platz: Preiszone („A“, „Loge“). Auf ihm kann eine Ticketkategorie der Veranstaltung mit derselben PredefinedBillingItem::ticketSeatZone gebucht werden; ohne Zone darf jede Kategorie gebucht werden.

  • 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

  • colorstring

    Hintergrundfarbe als Hexwert.

  • fg_colorstring

    Vordergrundfarbe als Hex-Wert.

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/event/base_location_plan_item \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "item_type": "string",
    "shape": "string",
    "pos_x": 1.5,
    "pos_y": 1.5,
    "width": 1.5,
    "height": 1.5
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "color": "#3f5efb",
  "fg_color": "#3f5efb",
  "plan": 1,
  "displayLabel": "string",
  "token": "string",
  "item_type": "string",
  "shape": "string",
  "pos_x": 1.5,
  "pos_y": 1.5
}

Liefert ein einzelnes BaseLocationPlanItem-Objekt.

GET/api/event/base_location_plan_item/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Liefert ein einzelnes BaseLocationPlanItem-Objekt.BaseLocationPlanItem

Felder anzeigen (25)
  • planinteger
  • displayLabelstring

    Auf dem Plan angezeigte Bezeichnung: die manuelle Bezeichnung hat Vorrang, sonst der gespeicherte Name des buchbaren Eintrags.

  • idinteger

    Primärschlüssel der Planposition. Interne ID.

  • tokenstring

    Öffentlicher Token der Planposition. Anstelle der ID verwendet.

  • item_typestring

    Art des Gegenstands, zum Beispiel Sitz, Tisch oder Etikett.

  • shapestring

    Form der Position im Plan.

  • pos_xnumber (float)

    Linker Rand, normiert 0.0 - 1.0

  • pos_ynumber (float)

    Obere Kante, normalisiert 0.0 - 1.0

  • widthnumber (float)

    Breite der Position in Planeinheiten.

  • heightnumber (float)

    Höhe des Elements in Planeinheiten.

  • rotationnumber (float)

    Drehung der Position in Grad.

  • z_indexinteger

    Stapelreihenfolge der Position im Plan.

  • labelstring

    Überschreibt den Buchbar-Namen im Plan.

  • iconstring

    Symbol, das auf dem Element angezeigt wird.

  • show_labelboolean

    Die Bezeichnung der Position anzeigen.

  • show_statusboolean

    Den Status der Position anzeigen.

  • show_nextboolean

    Die nächste Buchung der Position anzeigen.

  • seat_rowstring

    Platz: Reihe („5“, „B“), wie auf dem Ticket aufgedruckt.

  • seat_numberstring

    Platz: Nummer innerhalb der Reihe.

  • seat_zonestring

    Platz: Preiszone („A“, „Loge“). Auf ihm kann eine Ticketkategorie der Veranstaltung mit derselben PredefinedBillingItem::ticketSeatZone gebucht werden; ohne Zone darf jede Kategorie gebucht werden.

  • 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

  • colorstring

    Hintergrundfarbe als Hexwert.

  • fg_colorstring

    Vordergrundfarbe als Hex-Wert.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/event/base_location_plan_item/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "color": "#3f5efb",
  "fg_color": "#3f5efb",
  "plan": 1,
  "displayLabel": "string",
  "token": "string",
  "item_type": "string",
  "shape": "string",
  "pos_x": 1.5,
  "pos_y": 1.5
}

BaseLocationPlanItem aktualisieren

PUT/api/event/base_location_plan_item/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataBaseLocationPlanItem2
    Felder anzeigen (17)
    • item_typestring

      Art des Gegenstands, zum Beispiel Sitz, Tisch oder Etikett.

    • shapestring

      Form der Position im Plan.

    • pos_xnumber (float)

      Linker Rand, normiert 0.0 - 1.0

    • pos_ynumber (float)

      Obere Kante, normalisiert 0.0 - 1.0

    • widthnumber (float)

      Breite der Position in Planeinheiten.

    • heightnumber (float)

      Höhe des Elements in Planeinheiten.

    • rotationnumber (float)

      Drehung der Position in Grad.

    • z_indexinteger

      Stapelreihenfolge der Position im Plan.

    • labelstring

      Überschreibt den Buchbar-Namen im Plan.

    • iconstring

      Symbol, das auf dem Element angezeigt wird.

    • show_labelboolean

      Die Bezeichnung der Position anzeigen.

    • show_statusboolean

      Den Status der Position anzeigen.

    • show_nextboolean

      Die nächste Buchung der Position anzeigen.

    • seat_rowstring

      Platz: Reihe („5“, „B“), wie auf dem Ticket aufgedruckt.

    • seat_numberstring

      Platz: Nummer innerhalb der Reihe.

    • seat_zonestring

      Platz: Preiszone („A“, „Loge“). Auf ihm kann eine Ticketkategorie der Veranstaltung mit derselben PredefinedBillingItem::ticketSeatZone gebucht werden; ohne Zone darf jede Kategorie gebucht werden.

    • deletedboolean

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

Antworten

200BaseLocationPlanItem aktualisierenBaseLocationPlanItem

Felder anzeigen (25)
  • planinteger
  • displayLabelstring

    Auf dem Plan angezeigte Bezeichnung: die manuelle Bezeichnung hat Vorrang, sonst der gespeicherte Name des buchbaren Eintrags.

  • idinteger

    Primärschlüssel der Planposition. Interne ID.

  • tokenstring

    Öffentlicher Token der Planposition. Anstelle der ID verwendet.

  • item_typestring

    Art des Gegenstands, zum Beispiel Sitz, Tisch oder Etikett.

  • shapestring

    Form der Position im Plan.

  • pos_xnumber (float)

    Linker Rand, normiert 0.0 - 1.0

  • pos_ynumber (float)

    Obere Kante, normalisiert 0.0 - 1.0

  • widthnumber (float)

    Breite der Position in Planeinheiten.

  • heightnumber (float)

    Höhe des Elements in Planeinheiten.

  • rotationnumber (float)

    Drehung der Position in Grad.

  • z_indexinteger

    Stapelreihenfolge der Position im Plan.

  • labelstring

    Überschreibt den Buchbar-Namen im Plan.

  • iconstring

    Symbol, das auf dem Element angezeigt wird.

  • show_labelboolean

    Die Bezeichnung der Position anzeigen.

  • show_statusboolean

    Den Status der Position anzeigen.

  • show_nextboolean

    Die nächste Buchung der Position anzeigen.

  • seat_rowstring

    Platz: Reihe („5“, „B“), wie auf dem Ticket aufgedruckt.

  • seat_numberstring

    Platz: Nummer innerhalb der Reihe.

  • seat_zonestring

    Platz: Preiszone („A“, „Loge“). Auf ihm kann eine Ticketkategorie der Veranstaltung mit derselben PredefinedBillingItem::ticketSeatZone gebucht werden; ohne Zone darf jede Kategorie gebucht werden.

  • 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

  • colorstring

    Hintergrundfarbe als Hexwert.

  • fg_colorstring

    Vordergrundfarbe als Hex-Wert.

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/event/base_location_plan_item/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "item_type": "string",
    "shape": "string",
    "pos_x": 1.5,
    "pos_y": 1.5,
    "width": 1.5,
    "height": 1.5
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "color": "#3f5efb",
  "fg_color": "#3f5efb",
  "plan": 1,
  "displayLabel": "string",
  "token": "string",
  "item_type": "string",
  "shape": "string",
  "pos_x": 1.5,
  "pos_y": 1.5
}

BaseLocationPlanItem aktualisieren

PATCH/api/event/base_location_plan_item/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataBaseLocationPlanItem2
    Felder anzeigen (17)
    • item_typestring

      Art des Gegenstands, zum Beispiel Sitz, Tisch oder Etikett.

    • shapestring

      Form der Position im Plan.

    • pos_xnumber (float)

      Linker Rand, normiert 0.0 - 1.0

    • pos_ynumber (float)

      Obere Kante, normalisiert 0.0 - 1.0

    • widthnumber (float)

      Breite der Position in Planeinheiten.

    • heightnumber (float)

      Höhe des Elements in Planeinheiten.

    • rotationnumber (float)

      Drehung der Position in Grad.

    • z_indexinteger

      Stapelreihenfolge der Position im Plan.

    • labelstring

      Überschreibt den Buchbar-Namen im Plan.

    • iconstring

      Symbol, das auf dem Element angezeigt wird.

    • show_labelboolean

      Die Bezeichnung der Position anzeigen.

    • show_statusboolean

      Den Status der Position anzeigen.

    • show_nextboolean

      Die nächste Buchung der Position anzeigen.

    • seat_rowstring

      Platz: Reihe („5“, „B“), wie auf dem Ticket aufgedruckt.

    • seat_numberstring

      Platz: Nummer innerhalb der Reihe.

    • seat_zonestring

      Platz: Preiszone („A“, „Loge“). Auf ihm kann eine Ticketkategorie der Veranstaltung mit derselben PredefinedBillingItem::ticketSeatZone gebucht werden; ohne Zone darf jede Kategorie gebucht werden.

    • deletedboolean

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

Antworten

200BaseLocationPlanItem aktualisierenBaseLocationPlanItem

Felder anzeigen (25)
  • planinteger
  • displayLabelstring

    Auf dem Plan angezeigte Bezeichnung: die manuelle Bezeichnung hat Vorrang, sonst der gespeicherte Name des buchbaren Eintrags.

  • idinteger

    Primärschlüssel der Planposition. Interne ID.

  • tokenstring

    Öffentlicher Token der Planposition. Anstelle der ID verwendet.

  • item_typestring

    Art des Gegenstands, zum Beispiel Sitz, Tisch oder Etikett.

  • shapestring

    Form der Position im Plan.

  • pos_xnumber (float)

    Linker Rand, normiert 0.0 - 1.0

  • pos_ynumber (float)

    Obere Kante, normalisiert 0.0 - 1.0

  • widthnumber (float)

    Breite der Position in Planeinheiten.

  • heightnumber (float)

    Höhe des Elements in Planeinheiten.

  • rotationnumber (float)

    Drehung der Position in Grad.

  • z_indexinteger

    Stapelreihenfolge der Position im Plan.

  • labelstring

    Überschreibt den Buchbar-Namen im Plan.

  • iconstring

    Symbol, das auf dem Element angezeigt wird.

  • show_labelboolean

    Die Bezeichnung der Position anzeigen.

  • show_statusboolean

    Den Status der Position anzeigen.

  • show_nextboolean

    Die nächste Buchung der Position anzeigen.

  • seat_rowstring

    Platz: Reihe („5“, „B“), wie auf dem Ticket aufgedruckt.

  • seat_numberstring

    Platz: Nummer innerhalb der Reihe.

  • seat_zonestring

    Platz: Preiszone („A“, „Loge“). Auf ihm kann eine Ticketkategorie der Veranstaltung mit derselben PredefinedBillingItem::ticketSeatZone gebucht werden; ohne Zone darf jede Kategorie gebucht werden.

  • 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

  • colorstring

    Hintergrundfarbe als Hexwert.

  • fg_colorstring

    Vordergrundfarbe als Hex-Wert.

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/event/base_location_plan_item/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "item_type": "string",
    "shape": "string",
    "pos_x": 1.5,
    "pos_y": 1.5,
    "width": 1.5,
    "height": 1.5
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "color": "#3f5efb",
  "fg_color": "#3f5efb",
  "plan": 1,
  "displayLabel": "string",
  "token": "string",
  "item_type": "string",
  "shape": "string",
  "pos_x": 1.5,
  "pos_y": 1.5
}