Zum Inhalt

Page Options

Page Options sind frei nutzbare Datenslots pro Firma oder Immobilie. Ohne Premium stehen zehn Slots zur Verfügung, mit Premium sind es zwanzig. Sie eignen sich beispielsweise als Speicher für externe Webseiten. Die Daten haben keine direkte Auswirkung auf den Gamemode.

Firmenoption lesen

GET /factory/options/{firmenId}/{option}

Scopes: factory, factory.options

option liegt ohne Premium zwischen 1 und 10, mit Premium zwischen 1 und 20.

{
  "title": "Öffnungszeiten",
  "data": "Montag bis Freitag, 18 bis 22 Uhr",
  "lastUpdated": "2026-06-05T12:00:00.000Z"
}

Firmenoption bearbeiten

POST /factory/options

Scopes: factory, factory.options.edit

Zusätzlich zum Bearer-Token wird das API-Secret aus der API-Key-Übersicht benötigt.

{
  "apiSecret": "<API-Secret>",
  "factoryId": "65f...",
  "option": 1,
  "title": "Öffnungszeiten",
  "data": "Montag bis Freitag, 18 bis 22 Uhr"
}
Feld Einschränkung
option Ganzzahl von 1 bis 10, mit Premium bis 20
title Maximal 64 Zeichen
data Maximal 2400 Zeichen

Bei Erfolg antwortet die API mit:

option was updated

Immobilienoption lesen

GET /building/options/{buildingId}/{option}

Scopes: building, building.options

option liegt ohne Premium zwischen 1 und 10, mit Premium zwischen 1 und 20. Die Immobilie muss dem aktuellen Charakter direkt gehören.

{
  "title": "Hausordnung",
  "data": "Bitte haltet den Eingangsbereich frei.",
  "lastUpdated": "2026-06-05T12:00:00.000Z"
}

Immobilienoption bearbeiten

POST /building/options

Scopes: building, building.options.edit

Zusätzlich zum Bearer-Token wird das API-Secret aus der API-Key-Übersicht benötigt.

{
  "apiSecret": "<API-Secret>",
  "buildingId": "65f...",
  "option": 1,
  "title": "Hausordnung",
  "data": "Bitte haltet den Eingangsbereich frei."
}
Feld Einschränkung
option Ganzzahl von 1 bis 10, mit Premium bis 20
title Maximal 64 Zeichen
data Maximal 2400 Zeichen

Bei Erfolg antwortet die API mit:

option was updated