Zum Inhalt
edoobox Docs
Kostenlos testen 7 Tage unverbindlich testen
Menü
Kostenlos testen 7 Tage unverbindlich testen
OpenAPI herunterladen
emailtemplateAPI-Referenz
GET/v2/emailtemplate/{id}/preview

Vorlage mit Beispieldaten als HTML oder PDF rendern

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.

Operation-ID get_v2_emailtemplate_id_preview

01

Vertrag & Verhalten

Dokumentationsstand
reviewed
Ändert Zustand
Nein
Als readOnly markiert
Ja
Für Automation markiert
Ja
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

Pfadparameter

iderforderlich

Öffentliche et_-ID der Kontosprachfassung.

string

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

pattern
"^et_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"et_012345abcdef_123456"
Vollständiges Schema als JSON
{
  "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"
  ]
}

Query-Parameter

pdfoptional

Bei PDF-Vorlagen base64 für JSON, sonst direkte PDF-Ausgabe.

string

Standardwert: "file"

Erlaubte Werte
"base64""file"
Vollständiges Schema als JSON
{
  "type": "string",
  "enum": [
    "base64",
    "file"
  ],
  "default": "file"
}

Header

languageerforderlich

Sprachcode für die Beispieldaten, z.B. de.

string
Vollständiges Schema als JSON
{
  "type": "string"
}
04

Request Body

Kein Request Body in der Spezifikation beschrieben.

05

Antworten

9

HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.

200application/json · application/pdf

JSON für E-Mail-Vorschau oder Base64-PDF; andernfalls direktes PDF-Dokument. Fehler werden als JSON zurückgegeben.

application/json

object
success boolean
error boolean | string
type string
data Typ nicht eingeschränkt
anyOf · Mindestens eine Variante muss passen
Variante 1 object
id string erforderlich

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

pattern
"^et_[a-f0-9]{12}_-?[0-9]+$"
subject string erforderlich
html string erforderlich

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

Variante 2 object
id string erforderlich

Öffentliche v2-ID aus dem ausgewählten Konto; keine interne Datenbank-ID.

pattern
"^et_[a-f0-9]{12}_-?[0-9]+$"
pdf string erforderlich
contentEncoding
"base64"

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

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

Vollständiges Schema als JSON
{
  "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
}
Beispiel
{
  "success": true,
  "error": false,
  "data": {
    "id": "et_012345abcdef_123456",
    "subject": "Kursinformation",
    "html": "<p>Beispielvorschau</p>"
  }
}

application/pdf

string
format
"binary"
Vollständiges Schema als JSON
{
  "type": "string",
  "format": "binary"
}
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"
}
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"
}
06

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Emailtemplate.php:330getEmailtemplate()

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-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."
}
Vollständige Operation als 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": "<p>Beispielvorschau</p>"
            }
          }
        },
        "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."
  }
}