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

Buchungsansicht für einen Website-Pfad rendern

Rendert die öffentliche Angebotsübersicht, Angebotsdetailseite oder Zertifikatsansicht im wirksamen Buchungsdesign. filter mit property=template.path bestimmt den Website-Pfad; ohne Pfad wird die Startübersicht geladen. Optional setzt provider.url die Basisadresse für Links. edlink ersetzt einen template.path-Filter nur bei auto=true. no_jsonld=true oder 1 unterdrückt JSON-LD; die Antwort enthält header, content und footer, einschließlich HTML in content.widgets. Inhalte, Widgetoptionen und optionale Administrationsdaten hängen vom Konto, Pfad und angemeldeten Benutzer ab. Es werden keine Buchungen durch diese Lesefunktion angelegt; Renderdaten können im Cache gespeichert werden.

Operation-ID get_v2_template

01

Vertrag & Verhalten

Dokumentationsstand
reviewed
Ändert Zustand
Nein
Als readOnly markiert
Ja
Für Automation markiert
Nein
GET-Verhalten laut Spezifikation

read

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

Query-Parameter

filteroptional

Website-Pfad und optional provider.url als Basisadresse. Der Pfad enthält öffentliche URL-Segmente, keine rohen Datenbank-IDs.

application/json

array
Array-Elemente
object
property string erforderlich
value Typ nicht eingeschränkt erforderlich
auto boolean

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

Vollständiges Schema als JSON
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "property": {
        "type": "string"
      },
      "value": {},
      "auto": {
        "type": "boolean"
      }
    },
    "additionalProperties": true,
    "required": [
      "property",
      "value"
    ]
  }
}
Beispiel
[
  {
    "property": "template.path",
    "value": "de/kurse",
    "auto": true
  },
  {
    "property": "provider.url",
    "value": "https://www.example.invalid/kurse"
  }
]
no_jsonldoptional
boolean | integer | string

true, 1 sowie die Zeichenfolgen true/1 aktivieren die Option; andere Werte deaktivieren sie.

Schema-Beispiel
"true"
Vollständiges Schema als JSON
{
  "type": [
    "boolean",
    "integer",
    "string"
  ],
  "examples": [
    "true"
  ],
  "description": "true, 1 sowie die Zeichenfolgen true/1 aktivieren die Option; andere Werte deaktivieren sie."
}
edlinkoptional

Optionaler Ersatzpfad, wenn template.path den Eintrag auto=true enthält.

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

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"
  ]
}
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 die dynamischen Objekte header, content und footer. content.widgets ist HTML; keine reine HTML- oder Binärantwort.

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
header object erforderlich

Dynamische Seitenmetadaten, CSS- und Bootstrap-Informationen.

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

content object erforderlich
widgets string erforderlich

Gerenderte HTML-Fragmente der sichtbaren Widgets.

widgets_list array erforderlich
Array-Elemente
string
admin_menu Typ nicht eingeschränkt erforderlich

false oder optionale, berechtigungsabhängige Administrationsdaten.

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

footer object erforderlich

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": {
        "header": {
          "type": "object",
          "additionalProperties": true,
          "description": "Dynamische Seitenmetadaten, CSS- und Bootstrap-Informationen."
        },
        "content": {
          "type": "object",
          "properties": {
            "widgets": {
              "type": "string",
              "description": "Gerenderte HTML-Fragmente der sichtbaren Widgets."
            },
            "widgets_list": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "admin_menu": {
              "description": "false oder optionale, berechtigungsabhängige Administrationsdaten."
            }
          },
          "additionalProperties": true,
          "required": [
            "widgets",
            "widgets_list",
            "admin_menu"
          ]
        },
        "footer": {
          "type": "object",
          "additionalProperties": true
        }
      },
      "additionalProperties": true,
      "required": [
        "header",
        "content",
        "footer"
      ]
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}
Beispiel
{
  "success": true,
  "error": false,
  "data": {
    "header": {
      "title": "Kurse",
      "bootstrap_version": 5.3
    },
    "content": {
      "widgets": "<div>Beispielkurs</div>",
      "widgets_list": [
        "textb"
      ],
      "admin_menu": false
    },
    "footer": {
      "gtm_id": ""
    }
  }
}
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/Template.php:80getTemplate()

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
false
x-edoobox-runtimeMutationGuard
true
x-edoobox-get-effect
"read"
x-edoobox-documentationReview
{
  "file": "docs/openapi/operation-contracts/07-layout-files.json",
  "notes": []
}
x-edoobox-source
{
  "file": "application/models/v2/Template.php",
  "method": "getTemplate",
  "line": 80
}
x-edoobox-documentationStatus
"reviewed"
x-edoobox-readOnly
true
x-edoobox-safeForAutomation
false
x-edoobox-permission
{
  "resource": "template",
  "short": "teml",
  "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_template",
  "summary": "Buchungsansicht für einen Website-Pfad rendern",
  "description": "Rendert die öffentliche Angebotsübersicht, Angebotsdetailseite oder Zertifikatsansicht im wirksamen Buchungsdesign. filter mit property=template.path bestimmt den Website-Pfad; ohne Pfad wird die Startübersicht geladen. Optional setzt provider.url die Basisadresse für Links. edlink ersetzt einen template.path-Filter nur bei auto=true. no_jsonld=true oder 1 unterdrückt JSON-LD; die Antwort enthält header, content und footer, einschließlich HTML in content.widgets. Inhalte, Widgetoptionen und optionale Administrationsdaten hängen vom Konto, Pfad und angemeldeten Benutzer ab. Es werden keine Buchungen durch diese Lesefunktion angelegt; Renderdaten können im Cache gespeichert werden.",
  "tags": [
    "template"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "filter",
      "in": "query",
      "required": false,
      "description": "Website-Pfad und optional provider.url als Basisadresse. Der Pfad enthält öffentliche URL-Segmente, keine rohen Datenbank-IDs.",
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "property": {
                  "type": "string"
                },
                "value": {},
                "auto": {
                  "type": "boolean"
                }
              },
              "additionalProperties": true,
              "required": [
                "property",
                "value"
              ]
            }
          },
          "example": [
            {
              "property": "template.path",
              "value": "de/kurse",
              "auto": true
            },
            {
              "property": "provider.url",
              "value": "https://www.example.invalid/kurse"
            }
          ]
        }
      }
    },
    {
      "name": "no_jsonld",
      "in": "query",
      "required": false,
      "description": "",
      "schema": {
        "type": [
          "boolean",
          "integer",
          "string"
        ],
        "examples": [
          "true"
        ],
        "description": "true, 1 sowie die Zeichenfolgen true/1 aktivieren die Option; andere Werte deaktivieren sie."
      }
    },
    {
      "name": "edlink",
      "in": "query",
      "required": false,
      "description": "Optionaler Ersatzpfad, wenn template.path den Eintrag auto=true enthält.",
      "schema": {
        "type": "string",
        "examples": [
          "de/kurse"
        ]
      }
    },
    {
      "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": "data enthält die dynamischen Objekte header, content und footer. content.widgets ist HTML; keine reine HTML- oder Binärantwort.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "header": {
                "title": "Kurse",
                "bootstrap_version": 5.3
              },
              "content": {
                "widgets": "<div>Beispielkurs</div>",
                "widgets_list": [
                  "textb"
                ],
                "admin_menu": false
              },
              "footer": {
                "gtm_id": ""
              }
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "header": {
                    "type": "object",
                    "additionalProperties": true,
                    "description": "Dynamische Seitenmetadaten, CSS- und Bootstrap-Informationen."
                  },
                  "content": {
                    "type": "object",
                    "properties": {
                      "widgets": {
                        "type": "string",
                        "description": "Gerenderte HTML-Fragmente der sichtbaren Widgets."
                      },
                      "widgets_list": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "admin_menu": {
                        "description": "false oder optionale, berechtigungsabhängige Administrationsdaten."
                      }
                    },
                    "additionalProperties": true,
                    "required": [
                      "widgets",
                      "widgets_list",
                      "admin_menu"
                    ]
                  },
                  "footer": {
                    "type": "object",
                    "additionalProperties": true
                  }
                },
                "additionalProperties": true,
                "required": [
                  "header",
                  "content",
                  "footer"
                ]
              },
              "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/07-layout-files.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Template.php",
    "method": "getTemplate",
    "line": 80
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": true,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "template",
    "short": "teml",
    "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."
  }
}