Zum Inhalt
edoobox Docs
Kostenlos testen 7 Tage unverbindlich testen
Menü
Kostenlos testen 7 Tage unverbindlich testen
OpenAPI herunterladen
bookingqueueAPI-Referenz
GET/v2/bookingqueue

Status eines Warteraum-Eintrags prüfen

Liest Status, Position, erwartete Wartezeit, freie Plätze und Ablaufzeit des Eintrags mit queue_token. Der Aufruf bereinigt zuvor abgelaufene Einträge und kann freie Plätze an Wartende vergeben; er ist deshalb trotz Statusabfrage zustandsändernd. GET übermittelt data[queue_token] als PHP-Bracket-Query, POST verwendet data.queue_token.

Operation-ID get_v2_bookingqueue

01

Vertrag & Verhalten

Dokumentationsstand
reviewed
Ändert Zustand
Ja
Als readOnly markiert
Nein
Für Automation markiert
Nein

Dieser GET-Aufruf kann Zustand verändern. Die HTTP-Methode allein kennzeichnet hier keinen reinen Lesezugriff.

GET-Verhalten laut Spezifikation

maintenance

02

Authentifizierung

Eine der folgenden Alternativen muss erfüllt sein (ODER). Innerhalb jeder Alternative werden alle angegebenen Schemas gemeinsam benötigt (UND).

Alternative 1

bearerAuthhttp · bearer

Existing edoobox v2 access token. Never substitute API key/secret headers.

Format: JWT

Security-Schema als JSON
{
  "type": "http",
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "description": "Existing edoobox v2 access token. Never substitute API key/secret headers."
}
accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON
{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Alternative 2

sessionCookieapiKey

Existing browser login session, with the same permission checks as Bearer authentication.

cookie: _edlogin

Security-Schema als JSON
{
  "type": "apiKey",
  "in": "cookie",
  "name": "_edlogin",
  "description": "Existing browser login session, with the same permission checks as Bearer authentication."
}
accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON
{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Berechtigungen

Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope.

03

Parameter

Header

languageoptional

Account language code, where the resource supports setLanguage().

string
Schema-Beispiel
"de"
Vollständiges Schema als JSON
{
  "type": "string",
  "examples": [
    "de"
  ]
}
X-Edoobox-If-Revisionoptional

Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review.

string
pattern
"^[a-f0-9]{32}$"
Schema-Beispiel
"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
Vollständiges Schema als JSON
{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$",
  "examples": [
    "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  ]
}

Query-Parameter

data[queue_token]erforderlich

Bracket-Query wird als data.queue_token gelesen; JSON-Text in data wird beim GET nicht dekodiert.

string
pattern
"^[a-f0-9]{64}$"
Vollständiges Schema als JSON
{
  "type": "string",
  "pattern": "^[a-f0-9]{64}$"
}
Beispiel
"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
04

Request Body

Kein Request Body in der Spezifikation beschrieben.

05

Antworten

11

HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.

200application/json

data enthält den Wartestatus; bei join können bei geschlossenen/vollen Räumen Eintragstokens und Positionsfelder fehlen.

Response Header

X-Edoobox-Revision

Rotated account revision supplied for the next action in one reviewed sequence.

string
pattern
"^[a-f0-9]{32}$"
Vollständiges Schema als JSON
{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$"
}

application/json

object
success boolean
error boolean | string
error_code string
data object
waiting_room_required boolean
status string
mode string
Erlaubte Werte
"booking""waitlist"
offer string

Öffentliche v2-ID aus dem ausgewählten Konto; synthetische Beispiele ersetzen.

pattern
"^offer_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"offer_012345abcdef_123456"
scope string
Erlaubte Werte
"account""offer"
queue_token string
pattern
"^[a-f0-9]{64}$"
position integer
estimated_wait_seconds integer
active_limit integer
free_places integer | null
expires_at integer
admission_token string
pattern
"^[a-f0-9]{64}$"

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

type string

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON
{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "boolean",
        "string"
      ]
    },
    "error_code": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "waiting_room_required": {
          "type": "boolean"
        },
        "status": {
          "type": "string"
        },
        "mode": {
          "type": "string",
          "enum": [
            "booking",
            "waitlist"
          ]
        },
        "offer": {
          "type": "string",
          "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
          "description": "Öffentliche v2-ID aus dem ausgewählten Konto; synthetische Beispiele ersetzen.",
          "examples": [
            "offer_012345abcdef_123456"
          ]
        },
        "scope": {
          "type": "string",
          "enum": [
            "account",
            "offer"
          ]
        },
        "queue_token": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        },
        "position": {
          "type": "integer"
        },
        "estimated_wait_seconds": {
          "type": "integer"
        },
        "active_limit": {
          "type": "integer"
        },
        "free_places": {
          "type": [
            "integer",
            "null"
          ]
        },
        "expires_at": {
          "type": "integer"
        },
        "admission_token": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        }
      },
      "additionalProperties": true
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}
Beispiel
{
  "success": true,
  "error": false,
  "data": {
    "waiting_room_required": true,
    "status": "waiting",
    "mode": "booking",
    "offer": "offer_012345abcdef_123456",
    "scope": "account",
    "queue_token": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "position": 2,
    "estimated_wait_seconds": 60,
    "active_limit": 100,
    "free_places": 12,
    "expires_at": 1792400090
  }
}
400application/json

Invalid request.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED40006"
}
401application/json

Missing/expired token, missing account context, account paused or model-specific authorization failure.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED40103"
}
402application/json

Missing/invalid action data or subscription/operation restriction.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED80100"
}
403application/json

Permission denied. Browser CORS rejection may have an empty body.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED40340"
}
404application/json

Unknown resource/action or unsupported method.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED80019"
}
409application/json

The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.

application/json

object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON
{
  "type": "object",
  "additionalProperties": true
}
Beispiel
{
  "error": "ED40901",
  "error_code": "mutation_revision_conflict"
}
422application/json

Validation failed.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED80020"
}
429application/json

Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.

Response Header

Retry-After

Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.

string
Schema-Beispiel
"30"
Vollständiges Schema als JSON
{
  "type": "string",
  "examples": [
    "30"
  ]
}

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED42902"
}
502application/json

Server-side operation failed.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED50201"
}
503application/json

The account mutation lock or revision store is unavailable. No unprotected fallback is executed.

Response Header

Retry-After

integer

Fester Wert: 1

Vollständiges Schema als JSON
{
  "type": "integer",
  "const": 1
}

application/json

object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON
{
  "type": "object",
  "additionalProperties": true
}
Beispiel
{
  "error": "ED50301",
  "error_code": "mutation_revision_busy"
}
06

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Bookingqueue.php:39getBookingqueue()

Diese Angaben stammen unverändert aus der gelieferten OpenAPI-Datei. Zusätzliche Freigaben, Vorbedingungen, sensible Felder und Hinweise stehen in den Erweiterungen.

x-edoobox-mutates-state
true
x-edoobox-server-authorization
true
x-edoobox-server-authorization-source
{
  "file": "application/models/v2/Bookingqueuefunc.php",
  "line": 173,
  "reason": "Dedicated queue token plus authenticated account checks; GET also cleans expired queue entries."
}
x-edoobox-mutationReview
{
  "source": {
    "file": "application/models/v2/Bookingqueuefunc.php",
    "line": 180
  },
  "reason": "Status polling cleans expired entries and can admit the next queue member."
}
x-edoobox-runtimeMutationGuard
true
x-edoobox-get-effect
"maintenance"
x-edoobox-documentationReview
{
  "file": "docs/openapi/operation-contracts/02-booking-users.json",
  "notes": []
}
x-edoobox-source
{
  "file": "application/models/v2/Bookingqueue.php",
  "method": "getBookingqueue",
  "line": 39
}
x-edoobox-documentationStatus
"reviewed"
x-edoobox-readOnly
false
x-edoobox-safeForAutomation
false
x-edoobox-permission
{
  "resource": "bookingqueue",
  "short": null,
  "checkedByDispatcher": false,
  "levels": [
    1,
    3,
    4
  ],
  "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
}
Vollständige Operation als JSON
{
  "operationId": "get_v2_bookingqueue",
  "summary": "Status eines Warteraum-Eintrags prüfen",
  "description": "Liest Status, Position, erwartete Wartezeit, freie Plätze und Ablaufzeit des Eintrags mit queue_token. Der Aufruf bereinigt zuvor abgelaufene Einträge und kann freie Plätze an Wartende vergeben; er ist deshalb trotz Statusabfrage zustandsändernd. GET übermittelt data[queue_token] als PHP-Bracket-Query, POST verwendet data.queue_token.",
  "tags": [
    "bookingqueue"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    },
    {
      "in": "query",
      "name": "data[queue_token]",
      "required": true,
      "schema": {
        "type": "string",
        "pattern": "^[a-f0-9]{64}$"
      },
      "example": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "description": "Bracket-Query wird als data.queue_token gelesen; JSON-Text in data wird beim GET nicht dekodiert."
    },
    {
      "name": "X-Edoobox-If-Revision",
      "in": "header",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^[a-f0-9]{32}$",
        "examples": [
          "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        ]
      },
      "description": "Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review."
    }
  ],
  "responses": {
    "200": {
      "description": "data enthält den Wartestatus; bei join können bei geschlossenen/vollen Räumen Eintragstokens und Positionsfelder fehlen.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "waiting_room_required": true,
              "status": "waiting",
              "mode": "booking",
              "offer": "offer_012345abcdef_123456",
              "scope": "account",
              "queue_token": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
              "position": 2,
              "estimated_wait_seconds": 60,
              "active_limit": 100,
              "free_places": 12,
              "expires_at": 1792400090
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "waiting_room_required": {
                    "type": "boolean"
                  },
                  "status": {
                    "type": "string"
                  },
                  "mode": {
                    "type": "string",
                    "enum": [
                      "booking",
                      "waitlist"
                    ]
                  },
                  "offer": {
                    "type": "string",
                    "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID aus dem ausgewählten Konto; synthetische Beispiele ersetzen.",
                    "examples": [
                      "offer_012345abcdef_123456"
                    ]
                  },
                  "scope": {
                    "type": "string",
                    "enum": [
                      "account",
                      "offer"
                    ]
                  },
                  "queue_token": {
                    "type": "string",
                    "pattern": "^[a-f0-9]{64}$"
                  },
                  "position": {
                    "type": "integer"
                  },
                  "estimated_wait_seconds": {
                    "type": "integer"
                  },
                  "active_limit": {
                    "type": "integer"
                  },
                  "free_places": {
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "expires_at": {
                    "type": "integer"
                  },
                  "admission_token": {
                    "type": "string",
                    "pattern": "^[a-f0-9]{64}$"
                  }
                },
                "additionalProperties": true
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "headers": {
        "X-Edoobox-Revision": {
          "schema": {
            "type": "string",
            "pattern": "^[a-f0-9]{32}$"
          },
          "description": "Rotated account revision supplied for the next action in one reviewed sequence."
        }
      }
    },
    "400": {
      "description": "Invalid request.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40006"
          }
        }
      }
    },
    "401": {
      "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40103"
          }
        }
      }
    },
    "402": {
      "description": "Missing/invalid action data or subscription/operation restriction.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80100"
          }
        }
      }
    },
    "403": {
      "description": "Permission denied. Browser CORS rejection may have an empty body.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40340"
          }
        }
      }
    },
    "404": {
      "description": "Unknown resource/action or unsupported method.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80019"
          }
        }
      }
    },
    "409": {
      "description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED40901",
            "error_code": "mutation_revision_conflict"
          }
        }
      }
    },
    "422": {
      "description": "Validation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80020"
          }
        }
      }
    },
    "429": {
      "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED42902"
          }
        }
      },
      "headers": {
        "Retry-After": {
          "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.",
          "schema": {
            "type": "string",
            "examples": [
              "30"
            ]
          }
        }
      }
    },
    "502": {
      "description": "Server-side operation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED50201"
          }
        }
      }
    },
    "503": {
      "description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "const": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED50301",
            "error_code": "mutation_revision_busy"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": true,
  "x-edoobox-server-authorization": true,
  "x-edoobox-server-authorization-source": {
    "file": "application/models/v2/Bookingqueuefunc.php",
    "line": 173,
    "reason": "Dedicated queue token plus authenticated account checks; GET also cleans expired queue entries."
  },
  "x-edoobox-mutationReview": {
    "source": {
      "file": "application/models/v2/Bookingqueuefunc.php",
      "line": 180
    },
    "reason": "Status polling cleans expired entries and can admit the next queue member."
  },
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-get-effect": "maintenance",
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/02-booking-users.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Bookingqueue.php",
    "method": "getBookingqueue",
    "line": 39
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "bookingqueue",
    "short": null,
    "checkedByDispatcher": false,
    "levels": [
      1,
      3,
      4
    ],
    "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
  }
}