Zum Inhalt
edoobox Docs
Kostenlos testen 7 Tage unverbindlich testen
Menü
Kostenlos testen 7 Tage unverbindlich testen
OpenAPI herunterladen
bookingAPI-Referenz
GET/v2/booking/{id}/certificate.pdf/{participantOrUserId}/{cacheToken}

Teilnahmezertifikat einer Teilnehmerposition laden

Rendert das Teilnahmezertifikat für participantOrUserId innerhalb der angegebenen Buchung. Eine participant-ID bezeichnet die konkrete Teilnahme; eine ältere user-ID ist nur bei genau einer passenden Teilnehmerposition zulässig. Sichtbarkeit und Präsenzvoraussetzungen bleiben kontoabhängig. Ein optionales cacheToken wird nicht ausgewertet; die Antwort enthält PDF-Bytes. Beim Laden einer PDF-Vorlage kann der Vorlagencache erneuert werden.

Operation-ID get_v2_booking_id_certificate_pdf_participantOrUserId_cacheToken

01

Vertrag & Verhalten

Dokumentationsstand
reviewed
Ändert Zustand
Ja
Als readOnly markiert
Nein
Für Automation markiert
Nein

Dieser GET-Aufruf kann Zustand verändern. Die HTTP-Methode allein kennzeichnet hier keinen reinen Lesezugriff.

GET-Verhalten laut Spezifikation

maintenance

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

Header

languageoptional

Account language code, where the resource supports setLanguage().

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

Pfadparameter

iderforderlich
string

Opaque booking v2 ID returned by this account. Synthetic example is not a real record.

pattern
"^booking_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"booking_012345abcdef_123456"
Vollständiges Schema als JSON
{
  "type": "string",
  "pattern": "^booking_[a-f0-9]{12}_-?[0-9]+$",
  "description": "Opaque booking v2 ID returned by this account. Synthetic example is not a real record.",
  "examples": [
    "booking_012345abcdef_123456"
  ]
}
participantOrUserIderforderlich

Konkrete Teilnehmer-ID; ältere user-ID nur bei eindeutigem Teilnehmer innerhalb der Buchung.

Typ nicht eingeschränkt
anyOf · Mindestens eine Variante muss passen
Variante 1 string

Öffentliche v2-ID aus dem ausgewählten Konto.

pattern
"^participant_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"participant_012345abcdef_123456"
Variante 2 string

Öffentliche v2-ID aus dem ausgewählten Konto.

pattern
"^user_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"user_012345abcdef_123456"
Vollständiges Schema als JSON
{
  "anyOf": [
    {
      "type": "string",
      "pattern": "^participant_[a-f0-9]{12}_-?[0-9]+$",
      "examples": [
        "participant_012345abcdef_123456"
      ],
      "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
    },
    {
      "type": "string",
      "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
      "examples": [
        "user_012345abcdef_123456"
      ],
      "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
    }
  ]
}
cacheTokenerforderlich
string

Vue cache-busting token. The action consumes its ID/target before this exact trailing cache segment.

pattern
"^cAe-[0-9]+$"
Schema-Beispiel
"cAe-1792137600000"
Vollständiges Schema als JSON
{
  "type": "string",
  "pattern": "^cAe-[0-9]+$",
  "description": "Vue cache-busting token. The action consumes its ID/target before this exact trailing cache segment.",
  "examples": [
    "cAe-1792137600000"
  ]
}
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/pdf

Direkt gerendertes PDF; kontoabhängige Sichtbarkeit und Vorlagen bestimmen den Inhalt. Bei ungültigen Selektoren ist stattdessen eine JSON-Fehlerantwort möglich.

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/Bookingfunc.php:2648_getCertificatePDF()

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
true
x-edoobox-routeAliasEvidence
{
  "file": "application/models/v2/Bookingfunc.php",
  "method": "_getCertificatePDF",
  "line": 2648,
  "reason": "The certificate function consumes participant/user in segment5; the exact trailing Vue cAe timestamp remains a cache token."
}
x-edoobox-get-effect
"maintenance"
x-edoobox-get-permission-review
{
  "file": "docs/openapi/reviews/vue-get-permission-01.json",
  "pointer": "/operations/9",
  "sha256": "98bf744c7b83fe3aef56618efbe2f3f1c34a5a4790833fa03324cf7ba696c55d",
  "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
}
x-edoobox-mutationReview
{
  "source": {
    "file": "application/models/v2/Booking.php",
    "line": 918,
    "lineEnd": 921,
    "sha256": "78bb2e6d2875243f1267a8724ab29e406b7c93dd351c50f6a270f9c184ae81b5",
    "reason": "Certificate PDF branch dispatches to _getCertificatePDF."
  },
  "reason": "Validates an existing booking participant and renders the attendance certificate PDF without sending mail or persisting issuance.",
  "review": {
    "file": "docs/openapi/reviews/vue-get-permission-01.json",
    "pointer": "/operations/9",
    "sha256": "98bf744c7b83fe3aef56618efbe2f3f1c34a5a4790833fa03324cf7ba696c55d",
    "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/02-booking-users.json",
  "notes": []
}
x-edoobox-source
{
  "file": "application/models/v2/Bookingfunc.php",
  "method": "_getCertificatePDF",
  "line": 2648
}
x-edoobox-documentationStatus
"reviewed"
x-edoobox-readOnly
false
x-edoobox-safeForAutomation
false
x-edoobox-permission
{
  "resource": "booking",
  "short": "book",
  "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_booking_id_certificate_pdf_participantOrUserId_cacheToken",
  "summary": "Teilnahmezertifikat einer Teilnehmerposition laden",
  "description": "Rendert das Teilnahmezertifikat für participantOrUserId innerhalb der angegebenen Buchung. Eine participant-ID bezeichnet die konkrete Teilnahme; eine ältere user-ID ist nur bei genau einer passenden Teilnehmerposition zulässig. Sichtbarkeit und Präsenzvoraussetzungen bleiben kontoabhängig. Ein optionales cacheToken wird nicht ausgewertet; die Antwort enthält PDF-Bytes. Beim Laden einer PDF-Vorlage kann der Vorlagencache erneuert werden.",
  "tags": [
    "booking"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    },
    {
      "name": "id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "pattern": "^booking_[a-f0-9]{12}_-?[0-9]+$",
        "description": "Opaque booking v2 ID returned by this account. Synthetic example is not a real record.",
        "examples": [
          "booking_012345abcdef_123456"
        ]
      }
    },
    {
      "name": "participantOrUserId",
      "in": "path",
      "required": true,
      "schema": {
        "anyOf": [
          {
            "type": "string",
            "pattern": "^participant_[a-f0-9]{12}_-?[0-9]+$",
            "examples": [
              "participant_012345abcdef_123456"
            ],
            "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
          },
          {
            "type": "string",
            "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
            "examples": [
              "user_012345abcdef_123456"
            ],
            "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
          }
        ]
      },
      "description": "Konkrete Teilnehmer-ID; ältere user-ID nur bei eindeutigem Teilnehmer innerhalb der Buchung."
    },
    {
      "name": "cacheToken",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "pattern": "^cAe-[0-9]+$",
        "description": "Vue cache-busting token. The action consumes its ID/target before this exact trailing cache segment.",
        "examples": [
          "cAe-1792137600000"
        ]
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Direkt gerendertes PDF; kontoabhängige Sichtbarkeit und Vorlagen bestimmen den Inhalt. Bei ungültigen Selektoren ist stattdessen eine JSON-Fehlerantwort möglich.",
      "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": true,
  "x-edoobox-routeAliasEvidence": {
    "file": "application/models/v2/Bookingfunc.php",
    "method": "_getCertificatePDF",
    "line": 2648,
    "reason": "The certificate function consumes participant/user in segment5; the exact trailing Vue cAe timestamp remains a cache token."
  },
  "x-edoobox-get-effect": "maintenance",
  "x-edoobox-get-permission-review": {
    "file": "docs/openapi/reviews/vue-get-permission-01.json",
    "pointer": "/operations/9",
    "sha256": "98bf744c7b83fe3aef56618efbe2f3f1c34a5a4790833fa03324cf7ba696c55d",
    "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
  },
  "x-edoobox-mutationReview": {
    "source": {
      "file": "application/models/v2/Booking.php",
      "line": 918,
      "lineEnd": 921,
      "sha256": "78bb2e6d2875243f1267a8724ab29e406b7c93dd351c50f6a270f9c184ae81b5",
      "reason": "Certificate PDF branch dispatches to _getCertificatePDF."
    },
    "reason": "Validates an existing booking participant and renders the attendance certificate PDF without sending mail or persisting issuance.",
    "review": {
      "file": "docs/openapi/reviews/vue-get-permission-01.json",
      "pointer": "/operations/9",
      "sha256": "98bf744c7b83fe3aef56618efbe2f3f1c34a5a4790833fa03324cf7ba696c55d",
      "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/02-booking-users.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Bookingfunc.php",
    "method": "_getCertificatePDF",
    "line": 2648
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "booking",
    "short": "book",
    "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."
  }
}