# GET /v2/room/list/workload

Belegung für Raum abrufen

Liefert eine Tabelle der Termine, die den gewünschten Zeitraum überlappen. filter benötigt start und end als parsebare Datumswerte. Auf der Listenroute muss der erste Filter property=id mit einer einzelnen öffentlichen room-ID sein; mehrere Orte/Räume in einer Abfrage werden nicht unterstützt. Gelöschte bzw. im Papierkorb befindliche Angebote werden ausgeschlossen. Die Zeilen entsprechen der Reihenfolge in columns.

- Operation-ID: get_v2_room_list_workload
- Dokumentation: /docs/api/v2/operations/get-v2-room-list-workload-26a8a0208519/
- OpenAPI-Version: 3.2.1
- Vollständige Spezifikation: /docs/api/v2/openapi.json
- Dokumentationsstatus: reviewed
- Ändert Zustand: nein, gemäss Annotation
- Für Automation freigegeben: ja, siehe Voraussetzungen

## Server

Serverwerte stammen unverändert aus der Datei. Eine lokale Entwicklungsadresse ist keine bestätigte Produktionsadresse. `API_ORIGIN` muss auf die passende Instanz gesetzt werden.

```json
[
  {
    "url": "https://app2.edoobox.com",
    "description": "edoobox API"
  }
]
```

## Authentifizierung

Eine der folgenden Alternativen genügt (ODER). Innerhalb einer Alternative müssen alle Verfahren gemeinsam erfüllt sein (UND).

1. **bearerAuth** (HTTP bearer) — Existing edoobox v2 access token. Never substitute API key/secret headers. **UND** **accountContext** (header: edid) — Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.
2. **sessionCookie** (cookie: _edlogin) — Existing browser login session, with the same permission checks as Bearer authentication. **UND** **accountContext** (header: edid) — Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

### Wirksame Security Requirements und vollständige Verfahren

```json
{
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "securitySchemes": {
    "bearerAuth": {
      "type": "http",
      "scheme": "bearer",
      "bearerFormat": "JWT",
      "description": "Existing edoobox v2 access token. Never substitute API key/secret headers."
    },
    "accountContext": {
      "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."
    },
    "sessionCookie": {
      "type": "apiKey",
      "in": "cookie",
      "name": "_edlogin",
      "description": "Existing browser login session, with the same permission checks as Bearer authentication."
    }
  }
}
```

## Parameter

| Name | Ort | Pflicht | Beschreibung |
| --- | --- | --- | --- |
| filter | query | ja | Pflichtfilter: zuerst id, danach start und end. Die Zeitwerte werden mit PHP strtotime ausgewertet. |
| limit | query | nein | JSON-encoded limit value consumed by RequestAPIData / API_DATA; specific actions may ignore it. |
| language | header | nein | Account language code, where the resource supports setLanguage(). |

### Vollständige wirksame Parameterdefinitionen

```json
[
  {
    "name": "filter",
    "in": "query",
    "required": true,
    "description": "Pflichtfilter: zuerst id, danach start und end. Die Zeitwerte werden mit PHP strtotime ausgewertet.",
    "content": {
      "application/json": {
        "schema": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "property": {
                "type": "string"
              },
              "value": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        },
        "example": [
          {
            "property": "id",
            "value": "room_012345abcdef_123456"
          },
          {
            "property": "start",
            "value": "2026-11-01T00:00:00+01:00"
          },
          {
            "property": "end",
            "value": "2026-12-01T00:00:00+01:00"
          }
        ]
      }
    }
  },
  {
    "name": "limit",
    "in": "query",
    "required": false,
    "description": "JSON-encoded limit value consumed by RequestAPIData / API_DATA; specific actions may ignore it.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "start": {
              "type": "integer",
              "minimum": 0,
              "default": 0
            },
            "reply": {
              "type": "integer",
              "maximum": 2000,
              "default": 100
            }
          },
          "examples": [
            {
              "start": 0,
              "reply": 25
            }
          ]
        },
        "example": {
          "start": 0,
          "reply": 25
        }
      }
    }
  },
  {
    "name": "language",
    "in": "header",
    "required": false,
    "description": "Account language code, where the resource supports setLanguage().",
    "schema": {
      "type": "string",
      "examples": [
        "de"
      ]
    }
  }
]
```

## Anfrage

Kein Request Body deklariert.

## Antworten

HTTP-Status und Antwortinhalt gemeinsam auswerten. Die folgenden Beschreibungen und Schemata sind die Angaben der Quelldatei.

```json
{
  "200": {
    "description": "Response; inspect error and success as legacy failures may also use HTTP 200.",
    "content": {
      "application/json": {
        "example": {
          "success": true,
          "error": false,
          "data": {
            "columns": [
              {
                "field": "offername",
                "type": "string"
              },
              {
                "field": "name",
                "type": "string"
              },
              {
                "field": "offer_id",
                "type": "string"
              },
              {
                "field": "date_id",
                "type": "string"
              },
              {
                "field": "offerdef_id",
                "type": "string"
              },
              {
                "field": "place_id",
                "type": "string"
              },
              {
                "field": "room_id",
                "type": "string"
              },
              {
                "field": "status",
                "type": "integer"
              },
              {
                "field": "date_start",
                "type": "date"
              },
              {
                "field": "date_end",
                "type": "date"
              }
            ],
            "rows": [
              [
                "Beispielangebot",
                "Einführung",
                "offer_012345abcdef_123456",
                "date_012345abcdef_123456",
                "offerdef_012345abcdef_123456",
                "place_012345abcdef_123456",
                "room_012345abcdef_123456",
                1,
                "2026-11-03T09:00:00+01:00",
                "2026-11-03T10:00:00+01:00"
              ]
            ]
          }
        },
        "schema": {
          "type": "object",
          "properties": {
            "success": {
              "type": "boolean"
            },
            "error": {
              "type": [
                "boolean",
                "string"
              ]
            },
            "error_code": {
              "type": "string"
            },
            "data": {
              "type": "object",
              "properties": {
                "columns": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "field": {
                        "type": "string"
                      },
                      "type": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": true,
                    "required": [
                      "field",
                      "type"
                    ]
                  }
                },
                "rows": {
                  "type": "array",
                  "items": {
                    "type": "array",
                    "prefixItems": [
                      {
                        "type": "string"
                      },
                      {
                        "type": "string"
                      },
                      {
                        "type": "string",
                        "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
                        "examples": [
                          "offer_012345abcdef_123456"
                        ]
                      },
                      {
                        "type": "string",
                        "pattern": "^date_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
                        "examples": [
                          "date_012345abcdef_123456"
                        ]
                      },
                      {
                        "type": "string",
                        "pattern": "^offerdef_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
                        "examples": [
                          "offerdef_012345abcdef_123456"
                        ]
                      },
                      {
                        "anyOf": [
                          {
                            "type": "string",
                            "pattern": "^place_[a-f0-9]{12}_-?[0-9]+$",
                            "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
                            "examples": [
                              "place_012345abcdef_123456"
                            ]
                          },
                          {
                            "const": false
                          }
                        ]
                      },
                      {
                        "anyOf": [
                          {
                            "type": "string",
                            "pattern": "^room_[a-f0-9]{12}_-?[0-9]+$",
                            "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
                            "examples": [
                              "room_012345abcdef_123456"
                            ]
                          },
                          {
                            "const": false
                          }
                        ]
                      },
                      {
                        "type": "integer"
                      },
                      {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "const": false
                          }
                        ]
                      },
                      {
                        "anyOf": [
                          {
                            "type": "string"
                          },
                          {
                            "const": false
                          }
                        ]
                      }
                    ],
                    "minItems": 10,
                    "maxItems": 10
                  }
                }
              },
              "additionalProperties": true,
              "required": [
                "columns",
                "rows"
              ]
            },
            "type": {
              "type": "string"
            }
          },
          "additionalProperties": true
        }
      }
    }
  },
  "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"
        }
      }
    }
  },
  "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"
        }
      }
    }
  }
}
```

## Aufrufbeispiele

Anpassen vor dem Ausführen. Platzhalter und veröffentlichte Beispiele sind synthetisch. Die Beispiele senden hier keine Anfrage; sie ergänzen keine unbekannten Pflichtfelder.

### cURL

```sh
# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# filter: komplexen Wert vorab gemäss content/style/explode serialisieren; das Beispiel verwendet einen vorbereiteten Wert.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}"
: "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}"
: "${QUERY_FILTER:?QUERY_FILTER setzen}"
curl --request 'GET' \
  --url "${API_ORIGIN%/}"'/v2/room/list/workload' \
  --url-query 'filter='"${QUERY_FILTER}" \
  --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \
  --header 'edid: '"${AUTH_ACCOUNTCONTEXT}"
```

### JavaScript (Node.js)

```javascript
// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// filter: komplexen Wert vorab gemäss content/style/explode serialisieren; das Beispiel verwendet einen vorbereiteten Wert.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/room/list/workload";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
url.searchParams.append("filter", required("QUERY_FILTER"));
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
const response = await fetch(url, { method: "GET", headers, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.
```

### Python

```python
# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# filter: komplexen Wert vorab gemäss content/style/explode serialisieren; das Beispiel verwendet einen vorbereiteten Wert.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/room/list/workload"
url = os.environ["API_ORIGIN"].rstrip("/") + path
url += "?" + urllib.parse.urlencode([("filter", os.environ["QUERY_FILTER"])])
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="GET")
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.
```

## Vollständige Operationsdefinition und edoobox-Hinweise

Alle Originalfelder einschliesslich `x-edoobox-*`, requestBody und responses bleiben erhalten. Teilweise dokumentierte Schemata sind kein vollständiger Validierungsvertrag.

```json
{
  "operationId": "get_v2_room_list_workload",
  "summary": "Belegung für Raum abrufen",
  "description": "Liefert eine Tabelle der Termine, die den gewünschten Zeitraum überlappen. filter benötigt start und end als parsebare Datumswerte. Auf der Listenroute muss der erste Filter property=id mit einer einzelnen öffentlichen room-ID sein; mehrere Orte/Räume in einer Abfrage werden nicht unterstützt. Gelöschte bzw. im Papierkorb befindliche Angebote werden ausgeschlossen. Die Zeilen entsprechen der Reihenfolge in columns.",
  "tags": [
    "room"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "filter",
      "in": "query",
      "required": true,
      "description": "Pflichtfilter: zuerst id, danach start und end. Die Zeitwerte werden mit PHP strtotime ausgewertet.",
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "property": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              },
              "additionalProperties": true
            }
          },
          "example": [
            {
              "property": "id",
              "value": "room_012345abcdef_123456"
            },
            {
              "property": "start",
              "value": "2026-11-01T00:00:00+01:00"
            },
            {
              "property": "end",
              "value": "2026-12-01T00:00:00+01:00"
            }
          ]
        }
      }
    },
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "description": "JSON-encoded limit value consumed by RequestAPIData / API_DATA; specific actions may ignore it.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "start": {
                "type": "integer",
                "minimum": 0,
                "default": 0
              },
              "reply": {
                "type": "integer",
                "maximum": 2000,
                "default": 100
              }
            },
            "examples": [
              {
                "start": 0,
                "reply": 25
              }
            ]
          },
          "example": {
            "start": 0,
            "reply": 25
          }
        }
      }
    },
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Response; inspect error and success as legacy failures may also use HTTP 200.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "columns": [
                {
                  "field": "offername",
                  "type": "string"
                },
                {
                  "field": "name",
                  "type": "string"
                },
                {
                  "field": "offer_id",
                  "type": "string"
                },
                {
                  "field": "date_id",
                  "type": "string"
                },
                {
                  "field": "offerdef_id",
                  "type": "string"
                },
                {
                  "field": "place_id",
                  "type": "string"
                },
                {
                  "field": "room_id",
                  "type": "string"
                },
                {
                  "field": "status",
                  "type": "integer"
                },
                {
                  "field": "date_start",
                  "type": "date"
                },
                {
                  "field": "date_end",
                  "type": "date"
                }
              ],
              "rows": [
                [
                  "Beispielangebot",
                  "Einführung",
                  "offer_012345abcdef_123456",
                  "date_012345abcdef_123456",
                  "offerdef_012345abcdef_123456",
                  "place_012345abcdef_123456",
                  "room_012345abcdef_123456",
                  1,
                  "2026-11-03T09:00:00+01:00",
                  "2026-11-03T10:00:00+01:00"
                ]
              ]
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "columns": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "field": {
                          "type": "string"
                        },
                        "type": {
                          "type": "string"
                        }
                      },
                      "additionalProperties": true,
                      "required": [
                        "field",
                        "type"
                      ]
                    }
                  },
                  "rows": {
                    "type": "array",
                    "items": {
                      "type": "array",
                      "prefixItems": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "string"
                        },
                        {
                          "type": "string",
                          "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
                          "examples": [
                            "offer_012345abcdef_123456"
                          ]
                        },
                        {
                          "type": "string",
                          "pattern": "^date_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
                          "examples": [
                            "date_012345abcdef_123456"
                          ]
                        },
                        {
                          "type": "string",
                          "pattern": "^offerdef_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
                          "examples": [
                            "offerdef_012345abcdef_123456"
                          ]
                        },
                        {
                          "anyOf": [
                            {
                              "type": "string",
                              "pattern": "^place_[a-f0-9]{12}_-?[0-9]+$",
                              "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
                              "examples": [
                                "place_012345abcdef_123456"
                              ]
                            },
                            {
                              "const": false
                            }
                          ]
                        },
                        {
                          "anyOf": [
                            {
                              "type": "string",
                              "pattern": "^room_[a-f0-9]{12}_-?[0-9]+$",
                              "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
                              "examples": [
                                "room_012345abcdef_123456"
                              ]
                            },
                            {
                              "const": false
                            }
                          ]
                        },
                        {
                          "type": "integer"
                        },
                        {
                          "anyOf": [
                            {
                              "type": "string"
                            },
                            {
                              "const": false
                            }
                          ]
                        },
                        {
                          "anyOf": [
                            {
                              "type": "string"
                            },
                            {
                              "const": false
                            }
                          ]
                        }
                      ],
                      "minItems": 10,
                      "maxItems": 10
                    }
                  }
                },
                "additionalProperties": true,
                "required": [
                  "columns",
                  "rows"
                ]
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      }
    },
    "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"
          }
        }
      }
    },
    "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"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": false,
  "x-edoobox-mutationReview": {
    "source": {
      "file": "application/models/v2/Adminfunc.php",
      "line": 172
    },
    "reason": "Workload SELECT and formatting only; Placefunc194/Roomfunc12 likewise."
  },
  "x-edoobox-runtimeMutationGuard": false,
  "x-edoobox-get-effect": "read",
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/03-offers-places.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Room.php",
    "method": "getRoom",
    "line": 157,
    "branch": {
      "file": "application/models/v2/Room.php",
      "line": 173
    }
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": true,
  "x-edoobox-safeForAutomation": true,
  "x-edoobox-permission": {
    "resource": "room",
    "short": "room",
    "checkedByDispatcher": true,
    "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."
  }
}
```