Zum Inhalt
edoobox Docs
Kostenlos testen 7 Tage unverbindlich testen
Menü
Kostenlos testen 7 Tage unverbindlich testen
OpenAPI herunterladen
layoutAPI-Referenz
POST/v2/layout/{id}/pdf/render

PDF aus Layout und Angebotsdaten erzeugen

Erzeugt ein PDF aus dem gespeicherten Layout, dem ausgewählten Angebot und den zugehörigen Teilnehmer-/Termindaten. data.offer ist erforderlich; data.date_start kann den Startzeitpunkt für Terminspalten bestimmen. Verifizierte Hintergrundvorlagen und Anhänge werden eingebunden. Die Antwort ist binäres application/pdf; pdf=inline zeigt es an, andernfalls wird es heruntergeladen. Die Route speichert keine neue Geschäftsdatei; gelesene Vorlagen können zwischengespeichert werden.

Operation-ID post_v2_layout_id_pdf_render

01

Vertrag & Verhalten

Dokumentationsstand
reviewed
Ändert Zustand
Nein
Als readOnly markiert
Ja
Für Automation markiert
Nein
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 v2-ID des ausgewählten Objekts.

string

Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.

pattern
"^layoutpdf_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"layoutpdf_012345abcdef_123456"
Vollständiges Schema als JSON
{
  "type": "string",
  "pattern": "^layoutpdf_[a-f0-9]{12}_-?[0-9]+$",
  "description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.",
  "examples": [
    "layoutpdf_012345abcdef_123456"
  ]
}

Query-Parameter

pdfoptional

Steuert Content-Disposition der PDF-Antwort.

string

Standardwert: "download"

Erlaubte Werte
"download""inline"
Schema-Beispiel
"inline"
Vollständiges Schema als JSON
{
  "type": "string",
  "enum": [
    "download",
    "inline"
  ],
  "default": "download",
  "examples": [
    "inline"
  ]
}

Header

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

erforderlich

application/json

object
data object erforderlich
offer string erforderlich

Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.

pattern
"^offer_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"offer_012345abcdef_123456"
date_start Typ nicht eingeschränkt

Optionaler Startzeitpunkt für Terminspalten; dP normalisiert ein Datum bzw. einen Zeitstempel.

Schema-Beispiel
"2026-11-01T09:00:00+01:00"

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": {
    "data": {
      "type": "object",
      "properties": {
        "offer": {
          "type": "string",
          "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
          "description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.",
          "examples": [
            "offer_012345abcdef_123456"
          ]
        },
        "date_start": {
          "description": "Optionaler Startzeitpunkt für Terminspalten; dP normalisiert ein Datum bzw. einen Zeitstempel.",
          "examples": [
            "2026-11-01T09:00:00+01:00"
          ]
        }
      },
      "additionalProperties": true,
      "required": [
        "offer"
      ]
    }
  },
  "additionalProperties": true,
  "required": [
    "data"
  ]
}
PDF aus Layout und Angebotsdaten erzeugen
{
  "data": {
    "offer": "offer_012345abcdef_123456",
    "date_start": "2026-11-01T09:00:00+01:00"
  }
}
05

Antworten

11

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

200application/pdf

Binäres PDF mit Content-Disposition inline oder attachment; Validierungs- und Berechtigungsfehler bleiben JSON-Antworten.

Response Header

Content-Disposition

Dateiname aus dem PDF-Layout, bereinigt und auf 150 Zeichen begrenzt, mit .pdf.

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

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/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"
}
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/Layout.php:500postLayout()

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-action-contract
{
  "review": "layout-pdf-render",
  "status": "source-reviewed-partial",
  "sources": [
    {
      "file": "application/models/v2/Layout.php",
      "sha256": "d5bf4faf862da921710d9d2f553b14778a2b78eb8281a2f195dd5d52f9886eaf",
      "methods": [
        "postLayout"
      ]
    },
    {
      "file": "application/models/v2/Layoutfunc.php",
      "sha256": "04d3a25db87fd8c8e5f6fd8b6ec9cb899bf3d0bafcc7f286b76381c9e28afdc1",
      "methods": [
        "_renderLayoutPDF"
      ]
    }
  ],
  "preconditions": [
    "The layout exists in the selected account and is not soft-deleted. Offer/account context and required placeholders must resolve."
  ],
  "errors": [
    {
      "error": "ED80100",
      "meaning": "Missing layout/offer context in native Require_Data."
    }
  ],
  "unresolved": [
    "The native guard uses array_search without strict comparison; this contract states supported inputs without claiming every malformed value is rejected there.",
    "Dynamic placeholder inputs, account-dependent PDF composition and binary output remain native."
  ]
}
x-edoobox-runtimeMutationGuard
true
x-edoobox-documentationReview
{
  "file": "docs/openapi/operation-contracts/07-layout-files.json",
  "notes": []
}
x-edoobox-source
{
  "file": "application/models/v2/Layout.php",
  "line": 500,
  "sha256": "d5bf4faf862da921710d9d2f553b14778a2b78eb8281a2f195dd5d52f9886eaf",
  "method": "postLayout"
}
x-edoobox-documentationStatus
"reviewed"
x-edoobox-readOnly
true
x-edoobox-safeForAutomation
false
x-edoobox-permission
{
  "resource": "layout",
  "short": "lyot",
  "checkedByDispatcher": true,
  "levels": [
    2,
    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": "post_v2_layout_id_pdf_render",
  "summary": "PDF aus Layout und Angebotsdaten erzeugen",
  "description": "Erzeugt ein PDF aus dem gespeicherten Layout, dem ausgewählten Angebot und den zugehörigen Teilnehmer-/Termindaten. data.offer ist erforderlich; data.date_start kann den Startzeitpunkt für Terminspalten bestimmen. Verifizierte Hintergrundvorlagen und Anhänge werden eingebunden. Die Antwort ist binäres application/pdf; pdf=inline zeigt es an, andernfalls wird es heruntergeladen. Die Route speichert keine neue Geschäftsdatei; gelesene Vorlagen können zwischengespeichert werden.",
  "tags": [
    "layout"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "description": "Öffentliche v2-ID des ausgewählten Objekts.",
      "schema": {
        "type": "string",
        "pattern": "^layoutpdf_[a-f0-9]{12}_-?[0-9]+$",
        "description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.",
        "examples": [
          "layoutpdf_012345abcdef_123456"
        ]
      }
    },
    {
      "name": "pdf",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "enum": [
          "download",
          "inline"
        ],
        "default": "download",
        "examples": [
          "inline"
        ]
      },
      "description": "Steuert Content-Disposition der PDF-Antwort."
    },
    {
      "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": "Binäres PDF mit Content-Disposition inline oder attachment; Validierungs- und Berechtigungsfehler bleiben JSON-Antworten.",
      "headers": {
        "Content-Disposition": {
          "schema": {
            "type": "string"
          },
          "description": "Dateiname aus dem PDF-Layout, bereinigt und auf 150 Zeichen begrenzt, mit .pdf."
        },
        "X-Edoobox-Revision": {
          "schema": {
            "type": "string",
            "pattern": "^[a-f0-9]{32}$"
          },
          "description": "Rotated account revision supplied for the next action in one reviewed sequence."
        }
      },
      "content": {
        "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"
          }
        }
      }
    },
    "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,
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "offer": {
                  "type": "string",
                  "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                  "description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.",
                  "examples": [
                    "offer_012345abcdef_123456"
                  ]
                },
                "date_start": {
                  "description": "Optionaler Startzeitpunkt für Terminspalten; dP normalisiert ein Datum bzw. einen Zeitstempel.",
                  "examples": [
                    "2026-11-01T09:00:00+01:00"
                  ]
                }
              },
              "additionalProperties": true,
              "required": [
                "offer"
              ]
            }
          },
          "additionalProperties": true,
          "required": [
            "data"
          ]
        },
        "examples": {
          "request": {
            "summary": "PDF aus Layout und Angebotsdaten erzeugen",
            "value": {
              "data": {
                "offer": "offer_012345abcdef_123456",
                "date_start": "2026-11-01T09:00:00+01:00"
              }
            }
          }
        }
      }
    }
  },
  "x-edoobox-action-contract": {
    "review": "layout-pdf-render",
    "status": "source-reviewed-partial",
    "sources": [
      {
        "file": "application/models/v2/Layout.php",
        "sha256": "d5bf4faf862da921710d9d2f553b14778a2b78eb8281a2f195dd5d52f9886eaf",
        "methods": [
          "postLayout"
        ]
      },
      {
        "file": "application/models/v2/Layoutfunc.php",
        "sha256": "04d3a25db87fd8c8e5f6fd8b6ec9cb899bf3d0bafcc7f286b76381c9e28afdc1",
        "methods": [
          "_renderLayoutPDF"
        ]
      }
    ],
    "preconditions": [
      "The layout exists in the selected account and is not soft-deleted. Offer/account context and required placeholders must resolve."
    ],
    "errors": [
      {
        "error": "ED80100",
        "meaning": "Missing layout/offer context in native Require_Data."
      }
    ],
    "unresolved": [
      "The native guard uses array_search without strict comparison; this contract states supported inputs without claiming every malformed value is rejected there.",
      "Dynamic placeholder inputs, account-dependent PDF composition and binary output remain native."
    ]
  },
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/07-layout-files.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Layout.php",
    "line": 500,
    "sha256": "d5bf4faf862da921710d9d2f553b14778a2b78eb8281a2f195dd5d52f9886eaf",
    "method": "postLayout"
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": true,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "layout",
    "short": "lyot",
    "checkedByDispatcher": true,
    "levels": [
      2,
      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."
  }
}