Zum Inhalt springen
Developer

Kiosk Device

Veranstaltungen8 EndpunkteEvent / Kiosk Device

Liefert eine Liste von KioskDevices.

GET/api/event/kiosk_device

Query-Parameter

idinteger
deletedbooleanDiese Eigenschaft markiert eine Entität als gelöscht / archiviert | Benötigtes Zugriffsrecht: SCOPE | Standardwert: false
namestring
deviceIdstringÖffentliche Kennung des Geräts, übermittelt im Header x-iw-kiosk-device-id. | Benötigt Zugriffsrecht: SCOPE
lastSeenAtstringLetzte Anfrage des Geräts. | Benötigt Zugriffs-Tag: SCOPE
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 von KioskDevices.array<KioskDevice>

Felder anzeigen (8)
  • session_activeboolean

    Ob gerade jemand angemeldet ist – für die Verwaltungsoberfläche, ohne zu nennen, wer.

  • idinteger

    Primärschlüssel des Kiosk-Geräts. Interne ID.

  • device_idstring

    Öffentliche Kennung des Geräts, übermittelt im Header x-iw-kiosk-device-id.

  • last_seen_atstring (date-time)

    Letzte Anfrage des Geräts.

  • namestring

    Name der Einheit.

  • deletedboolean

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

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/event/kiosk_device \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "name": "Beispiel",
    "session_active": true,
    "device_id": "42",
    "last_seen_at": "2026-10-15T09:30:00+02:00",
    "deleted": true,
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  }
]

Fügt ein neues KioskDevice hinzu

POST/api/event/kiosk_device

Request-Body application/json

  • dataKioskDevice2
    Felder anzeigen (1)
    • deletedboolean

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

Antworten

200KioskDevice neu anlegenKioskDevice

Felder anzeigen (8)
  • session_activeboolean

    Ob gerade jemand angemeldet ist – für die Verwaltungsoberfläche, ohne zu nennen, wer.

  • idinteger

    Primärschlüssel des Kiosk-Geräts. Interne ID.

  • device_idstring

    Öffentliche Kennung des Geräts, übermittelt im Header x-iw-kiosk-device-id.

  • last_seen_atstring (date-time)

    Letzte Anfrage des Geräts.

  • namestring

    Name der Einheit.

  • deletedboolean

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

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

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

Liefert ein einzelnes KioskDevice-Objekt.

GET/api/event/kiosk_device/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Liefert ein einzelnes KioskDevice-Objekt.KioskDevice

Felder anzeigen (8)
  • session_activeboolean

    Ob gerade jemand angemeldet ist – für die Verwaltungsoberfläche, ohne zu nennen, wer.

  • idinteger

    Primärschlüssel des Kiosk-Geräts. Interne ID.

  • device_idstring

    Öffentliche Kennung des Geräts, übermittelt im Header x-iw-kiosk-device-id.

  • last_seen_atstring (date-time)

    Letzte Anfrage des Geräts.

  • namestring

    Name der Einheit.

  • deletedboolean

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

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/event/kiosk_device/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "session_active": true,
  "device_id": "42",
  "last_seen_at": "2026-10-15T09:30:00+02:00",
  "deleted": true,
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

KioskDevice aktualisieren

PUT/api/event/kiosk_device/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataKioskDevice2
    Felder anzeigen (1)
    • deletedboolean

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

Antworten

200KioskDevice aktualisierenKioskDevice

Felder anzeigen (8)
  • session_activeboolean

    Ob gerade jemand angemeldet ist – für die Verwaltungsoberfläche, ohne zu nennen, wer.

  • idinteger

    Primärschlüssel des Kiosk-Geräts. Interne ID.

  • device_idstring

    Öffentliche Kennung des Geräts, übermittelt im Header x-iw-kiosk-device-id.

  • last_seen_atstring (date-time)

    Letzte Anfrage des Geräts.

  • namestring

    Name der Einheit.

  • deletedboolean

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

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

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

KioskDevice aktualisieren

PATCH/api/event/kiosk_device/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataKioskDevice2
    Felder anzeigen (1)
    • deletedboolean

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

Antworten

200KioskDevice aktualisierenKioskDevice

Felder anzeigen (8)
  • session_activeboolean

    Ob gerade jemand angemeldet ist – für die Verwaltungsoberfläche, ohne zu nennen, wer.

  • idinteger

    Primärschlüssel des Kiosk-Geräts. Interne ID.

  • device_idstring

    Öffentliche Kennung des Geräts, übermittelt im Header x-iw-kiosk-device-id.

  • last_seen_atstring (date-time)

    Letzte Anfrage des Geräts.

  • namestring

    Name der Einheit.

  • deletedboolean

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

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

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

Löscht ein einzelnes KioskDevice

DELETE/api/event/kiosk_device/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Löscht ein einzelnes KioskDeviceKioskDevice

Felder anzeigen (8)
  • session_activeboolean

    Ob gerade jemand angemeldet ist – für die Verwaltungsoberfläche, ohne zu nennen, wer.

  • idinteger

    Primärschlüssel des Kiosk-Geräts. Interne ID.

  • device_idstring

    Öffentliche Kennung des Geräts, übermittelt im Header x-iw-kiosk-device-id.

  • last_seen_atstring (date-time)

    Letzte Anfrage des Geräts.

  • namestring

    Name der Einheit.

  • deletedboolean

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

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request DELETE \
  --url https://eure-instanz.iw-erp.de/api/event/kiosk_device/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "session_active": true,
  "device_id": "42",
  "last_seen_at": "2026-10-15T09:30:00+02:00",
  "deleted": true,
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

Liefert den Kopplungscode, den die Kiosk-App scannt oder manuell eingegeben erhält.

GET/api/event/kiosk_device/{identifier}/pairing

Getrennt vom Detail-Endpunkt, damit das Geheimnis gezielt abgerufen wird und nur in einer einzigen Antwort erscheint.

Pfad-Parameter

identifierPflichtstring

Antworten

200Kopplungscodeobject

Felder anzeigen (2)
  • device_idstring
  • pairing_codestring
Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/event/kiosk_device/42/pairing \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "device_id": "42",
  "pairing_code": "string"
}

Stellt ein neues Secret aus und beendet die laufende Sitzung. Der Kiosk muss mit dem neuen Code erneut gekoppelt werden.

POST/api/event/kiosk_device/{identifier}/rotate_secret

Pfad-Parameter

identifierPflichtstring

Antworten

default

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