/v2/category/list/shareurlFreigabe- und Buchungslinks für Kategorie abrufen
Ermittelt die vorhandenen Buchungs-, Einbettungs- und Trackinglinks sowie den internen Zugangscode. Bei Kindern eines Multi-Angebots beziehen sich die Links auf das übergeordnete Multi-Angebot; data.id bleibt die angefragte ID. Die Operation erstellt keine Buchung. filter muss einen Eintrag mit property=id und einer einzelnen öffentlichen category-ID enthalten.
Operation-ID get_v2_category_list_shareurl
Vertrag & Verhalten
- Dokumentationsstand
- reviewed
- Ändert Zustand
- Nein
- Als readOnly markiert
- Ja
- Für Automation markiert
- Nein
read
Authentifizierung
Eine der folgenden Alternativen muss erfüllt sein (ODER). Innerhalb jeder Alternative werden alle angegebenen Schemas gemeinsam benötigt (UND).
Alternative 1
bearerAuthhttp · bearerExisting 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."
}accountContextapiKeySelected 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
sessionCookieapiKeyExisting 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."
}accountContextapiKeySelected 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."
}Parameter
Query-Parameter
filtererforderlichJSON-Filterliste; ein einzelner id-Filter ist für diese Sammlung erforderlich.
application/json
Array-Elemente
property string value string Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.
- pattern
"^category_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"category_012345abcdef_123456"expression string Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Vollständiges Schema als JSON
{
"type": "array",
"items": {
"type": "object",
"properties": {
"property": {
"type": "string"
},
"value": {
"type": "string",
"pattern": "^category_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
"examples": [
"category_012345abcdef_123456"
]
},
"expression": {
"type": "string"
}
},
"additionalProperties": true
}
}Beispiel
[
{
"property": "id",
"value": "category_012345abcdef_123456"
}
]Header
languageoptionalAccount language code, where the resource supports setLanguage().
Schema-Beispiel
"de"Vollständiges Schema als JSON
{
"type": "string",
"examples": [
"de"
]
}X-Edoobox-If-RevisionoptionalOptional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review.
- pattern
"^[a-f0-9]{32}$"
Schema-Beispiel
"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"Vollständiges Schema als JSON
{
"type": "string",
"pattern": "^[a-f0-9]{32}$",
"examples": [
"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
]
}Request Body
Kein Request Body in der Spezifikation beschrieben.
Antworten
11HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.
200application/json
Ergebnis in data mit den beschriebenen Feldern; error und die Ergebniskennzeichen müssen ausgewertet werden.
Response Header
X-Edoobox-Revision
Rotated account revision supplied for the next action in one reviewed sequence.
- pattern
"^[a-f0-9]{32}$"
Vollständiges Schema als JSON
{
"type": "string",
"pattern": "^[a-f0-9]{32}$"
}application/json
success boolean error boolean | string error_code string data object id string erforderlich Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.
- pattern
"^category_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"category_012345abcdef_123456"shareurl object erforderlich internal_code string url object base string booknow string segment string gtm string iframe string shortcut string Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
data object iframe boolean Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.
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": {
"id": {
"type": "string",
"pattern": "^category_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
"examples": [
"category_012345abcdef_123456"
]
},
"shareurl": {
"type": "object",
"properties": {
"internal_code": {
"type": "string"
},
"url": {
"type": "object",
"properties": {
"base": {
"type": "string"
},
"booknow": {
"type": "string"
},
"segment": {
"type": "string"
},
"gtm": {
"type": "string"
},
"iframe": {
"type": "string"
},
"shortcut": {
"type": "string"
}
},
"additionalProperties": true
},
"data": {
"type": "object",
"properties": {
"iframe": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true,
"required": [
"id",
"shareurl"
]
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}Beispiel
{
"success": true,
"error": false,
"data": {
"id": "category_012345abcdef_123456",
"shareurl": {
"internal_code": "",
"url": {
"base": "https://app.edoobox.com/",
"booknow": "https://example.invalid/book",
"segment": "beispiel",
"gtm": "https://example.invalid/tracking",
"iframe": "",
"shortcut": "beispiel"
},
"data": {
"iframe": false
}
}
}
}400application/json
Invalid request.
application/json
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
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
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
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
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
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
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.
Schema-Beispiel
"30"Vollständiges Schema als JSON
{
"type": "string",
"examples": [
"30"
]
}application/json
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
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
Fester Wert: 1
Vollständiges Schema als JSON
{
"type": "integer",
"const": 1
}application/json
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"
}Quelle & Metadaten
application/models/v2/Category.php:550getCategory()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
falsex-edoobox-runtimeMutationGuard
truex-edoobox-get-effect
"read"x-edoobox-documentationReview
{
"file": "docs/openapi/operation-contracts/03-offers-places.json",
"notes": []
}x-edoobox-source
{
"file": "application/models/v2/Category.php",
"method": "getCategory",
"line": 550,
"branch": {
"file": "application/models/v2/Category.php",
"line": 564
}
}x-edoobox-documentationStatus
"reviewed"x-edoobox-readOnly
truex-edoobox-safeForAutomation
falsex-edoobox-permission
{
"resource": "category",
"short": "ctgy",
"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."
}Vollständige Operation als JSON
{
"operationId": "get_v2_category_list_shareurl",
"summary": "Freigabe- und Buchungslinks für Kategorie abrufen",
"description": "Ermittelt die vorhandenen Buchungs-, Einbettungs- und Trackinglinks sowie den internen Zugangscode. Bei Kindern eines Multi-Angebots beziehen sich die Links auf das übergeordnete Multi-Angebot; data.id bleibt die angefragte ID. Die Operation erstellt keine Buchung. filter muss einen Eintrag mit property=id und einer einzelnen öffentlichen category-ID enthalten.",
"tags": [
"category"
],
"security": [
{
"bearerAuth": [],
"accountContext": []
},
{
"sessionCookie": [],
"accountContext": []
}
],
"parameters": [
{
"name": "filter",
"in": "query",
"required": true,
"description": "JSON-Filterliste; ein einzelner id-Filter ist für diese Sammlung erforderlich.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"property": {
"type": "string"
},
"value": {
"type": "string",
"pattern": "^category_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
"examples": [
"category_012345abcdef_123456"
]
},
"expression": {
"type": "string"
}
},
"additionalProperties": true
}
},
"example": [
{
"property": "id",
"value": "category_012345abcdef_123456"
}
]
}
}
},
{
"name": "language",
"in": "header",
"required": false,
"description": "Account language code, where the resource supports setLanguage().",
"schema": {
"type": "string",
"examples": [
"de"
]
}
},
{
"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": "Ergebnis in data mit den beschriebenen Feldern; error und die Ergebniskennzeichen müssen ausgewertet werden.",
"content": {
"application/json": {
"example": {
"success": true,
"error": false,
"data": {
"id": "category_012345abcdef_123456",
"shareurl": {
"internal_code": "",
"url": {
"base": "https://app.edoobox.com/",
"booknow": "https://example.invalid/book",
"segment": "beispiel",
"gtm": "https://example.invalid/tracking",
"iframe": "",
"shortcut": "beispiel"
},
"data": {
"iframe": false
}
}
}
},
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"error": {
"type": [
"boolean",
"string"
]
},
"error_code": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^category_[a-f0-9]{12}_-?[0-9]+$",
"description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
"examples": [
"category_012345abcdef_123456"
]
},
"shareurl": {
"type": "object",
"properties": {
"internal_code": {
"type": "string"
},
"url": {
"type": "object",
"properties": {
"base": {
"type": "string"
},
"booknow": {
"type": "string"
},
"segment": {
"type": "string"
},
"gtm": {
"type": "string"
},
"iframe": {
"type": "string"
},
"shortcut": {
"type": "string"
}
},
"additionalProperties": true
},
"data": {
"type": "object",
"properties": {
"iframe": {
"type": "boolean"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true,
"required": [
"id",
"shareurl"
]
},
"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": false,
"x-edoobox-runtimeMutationGuard": true,
"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/Category.php",
"method": "getCategory",
"line": 550,
"branch": {
"file": "application/models/v2/Category.php",
"line": 564
}
},
"x-edoobox-documentationStatus": "reviewed",
"x-edoobox-readOnly": true,
"x-edoobox-safeForAutomation": false,
"x-edoobox-permission": {
"resource": "category",
"short": "ctgy",
"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."
}
}