BaseLocationPlan

Orte und Buchungen6 EndpunkteEvent / BaseLocationPlan

Liefert eine Liste der BaseLocationPlan-Objekte.

GET/api/event/base_location_plan

Query-Parameter

`id`integer
`deleted`boolean	Diese Eigenschaft markiert eine Entität als gelöscht / archiviert \| Benötigtes Zugriffsrecht: SCOPE \| Standardwert: false
`name`string
`token`string
`baseLocation`string
`floorLevel`string	Freitext-Bezeichnung der Etage, entspricht BaseBookable::getFloorLevel() \| Benötigt Zugriffsrecht: SCOPE
`planMode`string
`sortOrder`string	Reihenfolge der Etagen-Reiter innerhalb eines Standorts
`created`string
`updated`string
`searchString`string	Text, nach dem in der Liste gesucht wird
`orderFieldName`string	Name des Bestellfelds
`orderFieldSort`string	SortiermodusErlaubt: `DESCASC`
`page`integer	Seite der Liste
`pageSize`integer	Anzahl der Einträge je Seite
`withMaxPageNumber`string	gibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

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

Felder anzeigen (18)

aspectRationumber (float)
Seitenverhältnis des Hintergrundbilds, null, wenn die Abmessungen unbekannt sind.
idinteger
Primärschlüssel des Standortplans. Interne ID.
tokenstring
Öffentlicher Token des Standortplans. In Links anstelle der ID verwendet.
floor_levelstring
Freitext-Bezeichnung der Etage, entspricht BaseBookable::getFloorLevel()
sort_orderinteger
Reihenfolge der Etagen-Reiter innerhalb eines Standorts
plan_modestring
Art des Plans, zum Beispiel grid oder image.
image_widthinteger
Pixelbreite des Hintergrundbilds. Wird nur für das Seitenverhältnis verwendet; die Positionskoordinaten der Elemente sind normiert und damit auflösungsunabhängig.
image_heightinteger
Höhe des Planbildes in Pixeln.
grid_columnsinteger
Anzahl der Spalten des Rasters.
grid_rowsinteger
Anzahl der Zeilen des Rasters.
default_horizon_hoursinteger
Wie weit der Status-Endpunkt nach der nächsten Buchung sucht, in Stunden.
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
namestring
Name der Einheit.
image_urlstring
URL des Bildes des Datensatzes.
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 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://eure-instanz.iw-erp.de/api/event/base_location_plan', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/event/base_location_plan"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://eure-instanz.iw-erp.de/api/event/base_location_plan', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/event/base_location_plan"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/event/base_location_plan")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/event/base_location_plan"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/event_base_location_plan_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await EventBaseLocationPlanController.getAll();
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

[
  {
    "id": 42,
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "color": "#3f5efb",
    "fg_color": "#3f5efb",
    "aspectRatio": 1.5,
    "token": "string",
    "floor_level": "string",
    "sort_order": 1,
    "plan_mode": "string"
  }
]

BaseLocationPlan neu anlegen

POST/api/event/base_location_plan

Request-Body application/json

dataBaseLocationPlan2
Felder anzeigen (10)
- floor_levelstring
  Freitext-Bezeichnung der Etage, entspricht BaseBookable::getFloorLevel()
- sort_orderinteger
  Reihenfolge der Etagen-Reiter innerhalb eines Standorts
- plan_modestring
  Art des Plans, zum Beispiel grid oder image.
- image_widthinteger
  Pixelbreite des Hintergrundbilds. Wird nur für das Seitenverhältnis verwendet; die Positionskoordinaten der Elemente sind normiert und damit auflösungsunabhängig.
- image_heightinteger
  Höhe des Planbildes in Pixeln.
- grid_columnsinteger
  Anzahl der Spalten des Rasters.
- grid_rowsinteger
  Anzahl der Zeilen des Rasters.
- default_horizon_hoursinteger
  Wie weit der Status-Endpunkt nach der nächsten Buchung sucht, in Stunden.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- image_urlstring
  URL des Bildes des Datensatzes.

Antworten

200BaseLocationPlan neu anlegenBaseLocationPlan

Felder anzeigen (18)

aspectRationumber (float)
Seitenverhältnis des Hintergrundbilds, null, wenn die Abmessungen unbekannt sind.
idinteger
Primärschlüssel des Standortplans. Interne ID.
tokenstring
Öffentlicher Token des Standortplans. In Links anstelle der ID verwendet.
floor_levelstring
Freitext-Bezeichnung der Etage, entspricht BaseBookable::getFloorLevel()
sort_orderinteger
Reihenfolge der Etagen-Reiter innerhalb eines Standorts
plan_modestring
Art des Plans, zum Beispiel grid oder image.
image_widthinteger
Pixelbreite des Hintergrundbilds. Wird nur für das Seitenverhältnis verwendet; die Positionskoordinaten der Elemente sind normiert und damit auflösungsunabhängig.
image_heightinteger
Höhe des Planbildes in Pixeln.
grid_columnsinteger
Anzahl der Spalten des Rasters.
grid_rowsinteger
Anzahl der Zeilen des Rasters.
default_horizon_hoursinteger
Wie weit der Status-Endpunkt nach der nächsten Buchung sucht, in Stunden.
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
namestring
Name der Einheit.
image_urlstring
URL des Bildes des Datensatzes.
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 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "image_url": "https://vynst.de",
    "floor_level": "string",
    "sort_order": 1,
    "plan_mode": "string",
    "image_width": 1,
    "image_height": 1
  }
}
'

const options = {
  method: 'POST',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      image_url: 'https://vynst.de',
      floor_level: 'string',
      sort_order: 1,
      plan_mode: 'string',
      image_width: 1,
      image_height: 1
    }
  })
};

fetch('https://eure-instanz.iw-erp.de/api/event/base_location_plan', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/event/base_location_plan"

payload = { "data": {
    "image_url": "https://vynst.de",
    "floor_level": "string",
    "sort_order": 1,
    "plan_mode": "string",
    "image_width": 1,
    "image_height": 1
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://eure-instanz.iw-erp.de/api/event/base_location_plan', [
  'body' => '{"data":{"image_url":"https://vynst.de","floor_level":"string","sort_order":1,"plan_mode":"string","image_width":1,"image_height":1}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/event/base_location_plan"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"image_url\":\"https://vynst.de\",\"floor_level\":\"string\",\"sort_order\":1,\"plan_mode\":\"string\",\"image_width\":1,\"image_height\":1}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"image_url\":\"https://vynst.de\",\"floor_level\":\"string\",\"sort_order\":1,\"plan_mode\":\"string\",\"image_width\":1,\"image_height\":1}}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/event/base_location_plan")
  .post(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/event/base_location_plan"

	payload := strings.NewReader("{\"data\":{\"image_url\":\"https://vynst.de\",\"floor_level\":\"string\",\"sort_order\":1,\"plan_mode\":\"string\",\"image_width\":1,\"image_height\":1}}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/event_base_location_plan_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/event_base_location_plan.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await EventBaseLocationPlanController.post(EventBaseLocationPlan.fromJson({
  "image_url": "https://vynst.de",
  "floor_level": "string",
  "sort_order": 1,
  "plan_mode": "string",
  "image_width": 1,
  "image_height": 1
}));
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "color": "#3f5efb",
  "fg_color": "#3f5efb",
  "aspectRatio": 1.5,
  "token": "string",
  "floor_level": "string",
  "sort_order": 1,
  "plan_mode": "string"
}

Liefert ein einzelnes BaseLocationPlan-Objekt.

GET/api/event/base_location_plan/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Liefert ein einzelnes BaseLocationPlan-Objekt.BaseLocationPlan

Felder anzeigen (18)

aspectRationumber (float)
Seitenverhältnis des Hintergrundbilds, null, wenn die Abmessungen unbekannt sind.
idinteger
Primärschlüssel des Standortplans. Interne ID.
tokenstring
Öffentlicher Token des Standortplans. In Links anstelle der ID verwendet.
floor_levelstring
Freitext-Bezeichnung der Etage, entspricht BaseBookable::getFloorLevel()
sort_orderinteger
Reihenfolge der Etagen-Reiter innerhalb eines Standorts
plan_modestring
Art des Plans, zum Beispiel grid oder image.
image_widthinteger
Pixelbreite des Hintergrundbilds. Wird nur für das Seitenverhältnis verwendet; die Positionskoordinaten der Elemente sind normiert und damit auflösungsunabhängig.
image_heightinteger
Höhe des Planbildes in Pixeln.
grid_columnsinteger
Anzahl der Spalten des Rasters.
grid_rowsinteger
Anzahl der Zeilen des Rasters.
default_horizon_hoursinteger
Wie weit der Status-Endpunkt nach der nächsten Buchung sucht, in Stunden.
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
namestring
Name der Einheit.
image_urlstring
URL des Bildes des Datensatzes.
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/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://eure-instanz.iw-erp.de/api/event/base_location_plan/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/event/base_location_plan/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://eure-instanz.iw-erp.de/api/event/base_location_plan/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/event/base_location_plan/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/event/base_location_plan/42")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/event/base_location_plan/42"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/event_base_location_plan_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await EventBaseLocationPlanController.get('42');
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "color": "#3f5efb",
  "fg_color": "#3f5efb",
  "aspectRatio": 1.5,
  "token": "string",
  "floor_level": "string",
  "sort_order": 1,
  "plan_mode": "string"
}

BaseLocationPlan aktualisieren

PUT/api/event/base_location_plan/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

dataBaseLocationPlan2
Felder anzeigen (10)
- floor_levelstring
  Freitext-Bezeichnung der Etage, entspricht BaseBookable::getFloorLevel()
- sort_orderinteger
  Reihenfolge der Etagen-Reiter innerhalb eines Standorts
- plan_modestring
  Art des Plans, zum Beispiel grid oder image.
- image_widthinteger
  Pixelbreite des Hintergrundbilds. Wird nur für das Seitenverhältnis verwendet; die Positionskoordinaten der Elemente sind normiert und damit auflösungsunabhängig.
- image_heightinteger
  Höhe des Planbildes in Pixeln.
- grid_columnsinteger
  Anzahl der Spalten des Rasters.
- grid_rowsinteger
  Anzahl der Zeilen des Rasters.
- default_horizon_hoursinteger
  Wie weit der Status-Endpunkt nach der nächsten Buchung sucht, in Stunden.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- image_urlstring
  URL des Bildes des Datensatzes.

Antworten

200BaseLocationPlan aktualisierenBaseLocationPlan

Felder anzeigen (18)

aspectRationumber (float)
Seitenverhältnis des Hintergrundbilds, null, wenn die Abmessungen unbekannt sind.
idinteger
Primärschlüssel des Standortplans. Interne ID.
tokenstring
Öffentlicher Token des Standortplans. In Links anstelle der ID verwendet.
floor_levelstring
Freitext-Bezeichnung der Etage, entspricht BaseBookable::getFloorLevel()
sort_orderinteger
Reihenfolge der Etagen-Reiter innerhalb eines Standorts
plan_modestring
Art des Plans, zum Beispiel grid oder image.
image_widthinteger
Pixelbreite des Hintergrundbilds. Wird nur für das Seitenverhältnis verwendet; die Positionskoordinaten der Elemente sind normiert und damit auflösungsunabhängig.
image_heightinteger
Höhe des Planbildes in Pixeln.
grid_columnsinteger
Anzahl der Spalten des Rasters.
grid_rowsinteger
Anzahl der Zeilen des Rasters.
default_horizon_hoursinteger
Wie weit der Status-Endpunkt nach der nächsten Buchung sucht, in Stunden.
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
namestring
Name der Einheit.
image_urlstring
URL des Bildes des Datensatzes.
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/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "image_url": "https://vynst.de",
    "floor_level": "string",
    "sort_order": 1,
    "plan_mode": "string",
    "image_width": 1,
    "image_height": 1
  }
}
'

const options = {
  method: 'PUT',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      image_url: 'https://vynst.de',
      floor_level: 'string',
      sort_order: 1,
      plan_mode: 'string',
      image_width: 1,
      image_height: 1
    }
  })
};

fetch('https://eure-instanz.iw-erp.de/api/event/base_location_plan/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/event/base_location_plan/42"

payload = { "data": {
    "image_url": "https://vynst.de",
    "floor_level": "string",
    "sort_order": 1,
    "plan_mode": "string",
    "image_width": 1,
    "image_height": 1
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://eure-instanz.iw-erp.de/api/event/base_location_plan/42', [
  'body' => '{"data":{"image_url":"https://vynst.de","floor_level":"string","sort_order":1,"plan_mode":"string","image_width":1,"image_height":1}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Put,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/event/base_location_plan/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"image_url\":\"https://vynst.de\",\"floor_level\":\"string\",\"sort_order\":1,\"plan_mode\":\"string\",\"image_width\":1,\"image_height\":1}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"image_url\":\"https://vynst.de\",\"floor_level\":\"string\",\"sort_order\":1,\"plan_mode\":\"string\",\"image_width\":1,\"image_height\":1}}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/event/base_location_plan/42")
  .put(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/event/base_location_plan/42"

	payload := strings.NewReader("{\"data\":{\"image_url\":\"https://vynst.de\",\"floor_level\":\"string\",\"sort_order\":1,\"plan_mode\":\"string\",\"image_width\":1,\"image_height\":1}}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/event_base_location_plan_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/event_base_location_plan.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await EventBaseLocationPlanController.put(EventBaseLocationPlan.fromJson({
  "image_url": "https://vynst.de",
  "floor_level": "string",
  "sort_order": 1,
  "plan_mode": "string",
  "image_width": 1,
  "image_height": 1
}));
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "color": "#3f5efb",
  "fg_color": "#3f5efb",
  "aspectRatio": 1.5,
  "token": "string",
  "floor_level": "string",
  "sort_order": 1,
  "plan_mode": "string"
}

BaseLocationPlan aktualisieren

PATCH/api/event/base_location_plan/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

dataBaseLocationPlan2
Felder anzeigen (10)
- floor_levelstring
  Freitext-Bezeichnung der Etage, entspricht BaseBookable::getFloorLevel()
- sort_orderinteger
  Reihenfolge der Etagen-Reiter innerhalb eines Standorts
- plan_modestring
  Art des Plans, zum Beispiel grid oder image.
- image_widthinteger
  Pixelbreite des Hintergrundbilds. Wird nur für das Seitenverhältnis verwendet; die Positionskoordinaten der Elemente sind normiert und damit auflösungsunabhängig.
- image_heightinteger
  Höhe des Planbildes in Pixeln.
- grid_columnsinteger
  Anzahl der Spalten des Rasters.
- grid_rowsinteger
  Anzahl der Zeilen des Rasters.
- default_horizon_hoursinteger
  Wie weit der Status-Endpunkt nach der nächsten Buchung sucht, in Stunden.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- image_urlstring
  URL des Bildes des Datensatzes.

Antworten

200BaseLocationPlan aktualisierenBaseLocationPlan

Felder anzeigen (18)

aspectRationumber (float)
Seitenverhältnis des Hintergrundbilds, null, wenn die Abmessungen unbekannt sind.
idinteger
Primärschlüssel des Standortplans. Interne ID.
tokenstring
Öffentlicher Token des Standortplans. In Links anstelle der ID verwendet.
floor_levelstring
Freitext-Bezeichnung der Etage, entspricht BaseBookable::getFloorLevel()
sort_orderinteger
Reihenfolge der Etagen-Reiter innerhalb eines Standorts
plan_modestring
Art des Plans, zum Beispiel grid oder image.
image_widthinteger
Pixelbreite des Hintergrundbilds. Wird nur für das Seitenverhältnis verwendet; die Positionskoordinaten der Elemente sind normiert und damit auflösungsunabhängig.
image_heightinteger
Höhe des Planbildes in Pixeln.
grid_columnsinteger
Anzahl der Spalten des Rasters.
grid_rowsinteger
Anzahl der Zeilen des Rasters.
default_horizon_hoursinteger
Wie weit der Status-Endpunkt nach der nächsten Buchung sucht, in Stunden.
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
namestring
Name der Einheit.
image_urlstring
URL des Bildes des Datensatzes.
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/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "image_url": "https://vynst.de",
    "floor_level": "string",
    "sort_order": 1,
    "plan_mode": "string",
    "image_width": 1,
    "image_height": 1
  }
}
'

const options = {
  method: 'PATCH',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      image_url: 'https://vynst.de',
      floor_level: 'string',
      sort_order: 1,
      plan_mode: 'string',
      image_width: 1,
      image_height: 1
    }
  })
};

fetch('https://eure-instanz.iw-erp.de/api/event/base_location_plan/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/event/base_location_plan/42"

payload = { "data": {
    "image_url": "https://vynst.de",
    "floor_level": "string",
    "sort_order": 1,
    "plan_mode": "string",
    "image_width": 1,
    "image_height": 1
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://eure-instanz.iw-erp.de/api/event/base_location_plan/42', [
  'body' => '{"data":{"image_url":"https://vynst.de","floor_level":"string","sort_order":1,"plan_mode":"string","image_width":1,"image_height":1}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Patch,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/event/base_location_plan/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"image_url\":\"https://vynst.de\",\"floor_level\":\"string\",\"sort_order\":1,\"plan_mode\":\"string\",\"image_width\":1,\"image_height\":1}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"image_url\":\"https://vynst.de\",\"floor_level\":\"string\",\"sort_order\":1,\"plan_mode\":\"string\",\"image_width\":1,\"image_height\":1}}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/event/base_location_plan/42")
  .patch(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/event/base_location_plan/42"

	payload := strings.NewReader("{\"data\":{\"image_url\":\"https://vynst.de\",\"floor_level\":\"string\",\"sort_order\":1,\"plan_mode\":\"string\",\"image_width\":1,\"image_height\":1}}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit package:http (kein Controller im Package iw_erp_api)

import 'dart:convert';
import 'package:http/http.dart' as http;

final response = await http.patch(
  Uri.parse('https://eure-instanz.iw-erp.de/api/event/base_location_plan/42'),
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: jsonEncode({
    "data": {
      "image_url": "https://vynst.de",
      "floor_level": "string",
      "sort_order": 1,
      "plan_mode": "string",
      "image_width": 1,
      "image_height": 1
    }
  }),
);
print(response.body);

Antwort 200 application/json

{
  "id": 42,
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "color": "#3f5efb",
  "fg_color": "#3f5efb",
  "aspectRatio": 1.5,
  "token": "string",
  "floor_level": "string",
  "sort_order": 1,
  "plan_mode": "string"
}

Ersetzt die platzierten Elemente eines Plans in einer Anfrage.

POST/api/event/base_location_plan/{identifier}/items_bulk

Der Editor hält den vollständigen Stand der Positionen lokal und sendet ihn als Ganzes zurück, daher ist dies ein Ersetzen, kein Zusammenführen: Jede Position in der Nutzlast wird angelegt oder aktualisiert, und jede Position des Plans, die in der Nutzlast fehlt, wird als gelöscht markiert. Die Nutzlast wird insgesamt geprüft und in einer Transaktion geschrieben, sodass ein halb gespeicherter Plan ausgeschlossen ist. Bei planUpdated wird das Speichern abgelehnt (Fehlercode 409), wenn der Plan seit dem Laden durch den Client von jemand anderem gespeichert wurde.

Pfad-Parameter

identifierPflichtstring

Query-Parameter

`id`integer
`deleted`boolean	Diese Eigenschaft markiert eine Entität als gelöscht / archiviert \| Benötigtes Zugriffsrecht: SCOPE \| Standardwert: false
`token`string
`plan`string
`baseBookable`string
`itemType`string
`shape`string
`created`string
`updated`string
`searchString`string	Text, nach dem in der Liste gesucht wird
`orderFieldName`string	Name des Bestellfelds
`orderFieldSort`string	SortiermodusErlaubt: `DESCASC`
`page`integer	Seite der Liste
`pageSize`integer	Anzahl der Einträge je Seite
`withMaxPageNumber`string	gibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Request-Body application/json

planUpdatedstring (date-time)
Aktualisierungszeitstempel des Plans, wie ihn der Client geladen hat; stimmt er nicht mehr überein, schlägt das Speichern mit Fehlercode 409 fehl
itemsarray<object>Pflicht
Vollständiger Elementstatus des Plans. Elemente, die in dieser Liste fehlen, werden weich gelöscht. Höchstens 2000 Elemente.
Felder anzeigen (18)
- idinteger
  ID einer vorhandenen Position dieses Plans; fehlende oder fremde IDs legen eine neue Position an
- baseBookableinteger
  ID des platzierten Objekts (nicht archiviert), null bei Dekorationspositionen
- itemTypestring
  Erlaubt: bookable label area icon legend
- shapestring
  Erlaubt: rect circle polygon
- posXnumber
  linke Kante, 0..1 der Planbreite
- posYnumber
  obere Kante, 0..1 der Planhöhe
- widthnumber
  0..1 der Plan-Breite
- heightnumber
  0..1 der Plan-Höhe
- rotationnumber
  Grad
- polygonPointsarray<array<number>>
  [[x, y], ...] normalisiert, nur für Shape Polygon
- zIndexinteger
- labelstring
- iconstring
- colorstring
- fgColorstring
- showLabelboolean
- showStatusboolean
- showNextboolean

Antworten

200Liefert die gespeicherten Positionen des Plansarray<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 POST \
  --url https://eure-instanz.iw-erp.de/api/event/base_location_plan/42/items_bulk \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "items": [
    {
      "id": 42,
      "color": "#3f5efb",
      "baseBookable": 1,
      "itemType": "bookable",
      "shape": "rect",
      "posX": 1.5
    }
  ],
  "planUpdated": "2026-10-15T09:30:00+02:00"
}
'

const options = {
  method: 'POST',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    items: [
      {
        id: 42,
        color: '#3f5efb',
        baseBookable: 1,
        itemType: 'bookable',
        shape: 'rect',
        posX: 1.5
      }
    ],
    planUpdated: '2026-10-15T09:30:00+02:00'
  })
};

fetch('https://eure-instanz.iw-erp.de/api/event/base_location_plan/42/items_bulk', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/event/base_location_plan/42/items_bulk"

payload = {
  "items": [
    {
      "id": 42,
      "color": "#3f5efb",
      "baseBookable": 1,
      "itemType": "bookable",
      "shape": "rect",
      "posX": 1.5
    }
  ],
  "planUpdated": "2026-10-15T09:30:00+02:00"
}
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://eure-instanz.iw-erp.de/api/event/base_location_plan/42/items_bulk', [
  'body' => '{"items":[{"id":42,"color":"#3f5efb","baseBookable":1,"itemType":"bookable","shape":"rect","posX":1.5}],"planUpdated":"2026-10-15T09:30:00+02:00"}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/event/base_location_plan/42/items_bulk"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"items\":[{\"id\":42,\"color\":\"#3f5efb\",\"baseBookable\":1,\"itemType\":\"bookable\",\"shape\":\"rect\",\"posX\":1.5}],\"planUpdated\":\"2026-10-15T09:30:00+02:00\"}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"items\":[{\"id\":42,\"color\":\"#3f5efb\",\"baseBookable\":1,\"itemType\":\"bookable\",\"shape\":\"rect\",\"posX\":1.5}],\"planUpdated\":\"2026-10-15T09:30:00+02:00\"}");
Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/event/base_location_plan/42/items_bulk")
  .post(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/event/base_location_plan/42/items_bulk"

	payload := strings.NewReader("{\"items\":[{\"id\":42,\"color\":\"#3f5efb\",\"baseBookable\":1,\"itemType\":\"bookable\",\"shape\":\"rect\",\"posX\":1.5}],\"planUpdated\":\"2026-10-15T09:30:00+02:00\"}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/event_base_location_plan_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await EventBaseLocationPlanController.putItemsBulk(42, List<EventBaseLocationPlanItem>.fromJson({
  "items": [
    {
      "id": 42,
      "color": "#3f5efb",
      "baseBookable": 1,
      "itemType": "bookable",
      "shape": "rect",
      "posX": 1.5
    }
  ],
  "planUpdated": "2026-10-15T09:30:00+02:00"
}));
if (result.success) {
  print(result.data);
}

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
  }
]