Beispielvorschau
" } } }, "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "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. # cURL: PATH_* bereits URL-kodiert setzen. JavaScript/Python kodieren die unveränderten Pfadwerte selbst. : "${API_ORIGIN:?API_ORIGIN setzen}" : "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}" : "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}" : "${PATH_ID:?PATH_ID setzen}" : "${HEADER_LANGUAGE:?HEADER_LANGUAGE setzen}" curl --request 'GET' \ --url "${API_ORIGIN%/}"'/v2/emailtemplate/'"${PATH_ID}"'/preview' \ --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \ --header 'edid: '"${AUTH_ACCOUNTCONTEXT}" \ --header 'language: '"${HEADER_LANGUAGE}" ``` ### 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/emailtemplate/{id}/preview"; path = path.replaceAll("{id}", encodeURIComponent(required("PATH_ID"))); 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"); headers["language"] = "" + required("HEADER_LANGUAGE"); 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/emailtemplate/{id}/preview" path = path.replace("{id}", urllib.parse.quote(os.environ["PATH_ID"], safe="")) url = os.environ["API_ORIGIN"].rstrip("/") + path headers = {} headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"] headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"] headers["language"] = "" + os.environ["HEADER_LANGUAGE"] # 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_emailtemplate_id_preview", "summary": "Vorlage mit Beispieldaten als HTML oder PDF rendern", "description": "Rendert eine gespeicherte et_-Sprachfassung mit synthetischen Beispieldaten. Beide Aktionsnamen verwenden dieselbe Implementierung; der gespeicherte Vorlagentyp entscheidet über HTML oder PDF. language-Header ist Pflicht. E-Mail-Vorlagen liefern JSON mit id, subject und html. PDF-Vorlagen liefern mit pdf=base64 JSON mit id und pdf; sonst PDF-Bytes direkt. Es werden keine E-Mails versendet und keine Vorlage gespeichert.", "tags": [ "emailtemplate" ], "security": [ { "bearerAuth": [], "accountContext": [] }, { "sessionCookie": [], "accountContext": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Öffentliche et_-ID der Kontosprachfassung.", "schema": { "type": "string", "pattern": "^et_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.", "examples": [ "et_012345abcdef_123456" ] } }, { "name": "pdf", "in": "query", "required": false, "description": "Bei PDF-Vorlagen base64 für JSON, sonst direkte PDF-Ausgabe.", "schema": { "type": "string", "enum": [ "base64", "file" ], "default": "file" } }, { "name": "language", "in": "header", "required": true, "description": "Sprachcode für die Beispieldaten, z.B. de.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "JSON für E-Mail-Vorschau oder Base64-PDF; andernfalls direktes PDF-Dokument. Fehler werden als JSON zurückgegeben.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "error": { "type": [ "boolean", "string" ] }, "type": { "type": "string" }, "data": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^et_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID." }, "subject": { "type": "string" }, "html": { "type": "string" } }, "additionalProperties": true, "required": [ "id", "subject", "html" ] }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^et_[a-f0-9]{12}_-?[0-9]+$", "description": "Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID." }, "pdf": { "type": "string", "contentEncoding": "base64" } }, "additionalProperties": true, "required": [ "id", "pdf" ] } ] } }, "additionalProperties": true }, "example": { "success": true, "error": false, "data": { "id": "et_012345abcdef_123456", "subject": "Kursinformation", "html": "Beispielvorschau
" } } }, "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "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-get-effect": "read", "x-edoobox-get-permission-review": { "file": "docs/openapi/reviews/vue-get-permission-02.json", "pointer": "/operations/12", "sha256": "25310a80e8f92a0486b6f7538bd2165e0bb66dd59c60a097ee53cf8d950337fc", "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized." }, "x-edoobox-mutationReview": { "source": { "file": "application/config/config.php", "line": 358, "reason": "APIPermissions resource mapping to emtp.", "sha256": "8d7bcae1a154ab06f54007072f84af5fe87ae7349b1b06738e7adbd8ee084f82" }, "reason": "Renders a preview against dummy content, returning HTML or a generated PDF. It does not save the content, send mail, create bookings or issue legal documents.", "review": { "file": "docs/openapi/reviews/vue-get-permission-02.json", "pointer": "/operations/12", "sha256": "25310a80e8f92a0486b6f7538bd2165e0bb66dd59c60a097ee53cf8d950337fc", "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized." } }, "x-edoobox-runtimeMutationGuard": false, "x-edoobox-documentationReview": { "file": "docs/openapi/operation-contracts/09-messages-ai.json", "notes": [] }, "x-edoobox-source": { "file": "application/models/v2/Emailtemplate.php", "method": "getEmailtemplate", "line": 330, "branch": { "file": "application/models/v2/Emailtemplate.php", "line": 439 } }, "x-edoobox-documentationStatus": "reviewed", "x-edoobox-readOnly": true, "x-edoobox-safeForAutomation": true, "x-edoobox-permission": { "resource": "emailtemplate", "short": "emtp", "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." } } ```