# 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
- Dokumentation: /docs/api/v2/operations/get-v2-template-bc05787cf104/
- 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: nein

## 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 | nein | Website-Pfad und optional provider.url als Basisadresse. Der Pfad enthält öffentliche URL-Segmente, keine rohen Datenbank-IDs. |
| no_jsonld | query | nein |  |
| edlink | query | nein | Optionaler Ersatzpfad, wenn template.path den Eintrag auto=true enthält. |
| language | header | nein | Account language code, where the resource supports setLanguage(). |
| X-Edoobox-If-Revision | header | nein | 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. |

### Vollständige wirksame Parameterdefinitionen

```json
[
  {
    "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."
  }
]
```

## 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": "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"
        }
      }
    }
  }
}
```

## 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.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}"
: "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}"
curl --request 'GET' \
  --url "${API_ORIGIN%/}"'/v2/template' \
  --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \
  --header 'edid: '"${AUTH_ACCOUNTCONTEXT}"
```

### JavaScript (Node.js)

```javascript
// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/template";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
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.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/template"
url = os.environ["API_ORIGIN"].rstrip("/") + path
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_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."
  }
}
```