#S0007 - GET-Request: /api/document/{id}/pdf

Ruft die aktuelle Version eines Dokuments als PDF-Dokument ab.

URL-Schema

 

https://{HOST}:{PORT}/docbox.webapp/api/document/{id}/pdf

 

Path-Parameter

Name	Pflichtfeld	Datentyp	Anmerkung
id	Ja	Integer	Gibt die ID des Dokuments an, zu dem das PDF abgerufen werden soll.

Query-Parameter

Name	Pflichtfeld	Datentyp	Anmerkung
original	Nein	Boolean (true/false)	Optionaler Parameter, der angibt, dass für das erzeugte PDF die ursprünglichen PDFs der Einzelseiten verwendet werden (true) oder dass die aktuellen PDFs der Einzelseiten (die beispielsweise die gesetzten Stempel der jeweiligen Seite enthalten) verwendet werden (false). Der Default-Wert des Parameters ist false.
annotations	Nein	String-Liste (komma-separiert)	Optionaler Parameter, der die Annotationen auflistet, die auf das PDF gerendert werden sollen. Wird nur ausgewertet, wenn original auf Wert false gesetzt ist. Die möglichen Werte, die in der komma-separierten Liste enthalten sein dürfen sind „stamp“, „text“ und „symbol“. Beispiel: „stamp,text“

Beispiel:

 

GET /docbox.webapp/api/document/2392/pdf HTTP/1.1
Authorization: Basic VXNlcjpQYXNz
API-Key: dUdQBLnAZQ-4NwniKonV-wLkEyzsu4-OCxPGHZlZ

 

Erfolgreiche Antwort:

HTTP Status 200
Content-Type: application/pdf
Rückgabe des PDFs im Body der Antwort.

HTTP-Statuscodes

Error-Codes	Erläuterung
400 Bad Request	Fehlende oder ungültige Parameter
401 Unauthorized	Ungültige Zugangsdaten
403 Forbidden	Fehlende Berechtigungen oder DOCBOX®-Module
404 Not found	Dokument nicht gefunden
500 Server Error	Serverseitiger Fehler, z.B. Datenbankfehler
501 Not implemented	Nicht unterstützte HTTP Methode verwendet

Hinweis:
Hierbei handelt es sich um Beispiel URLs. Sämtliche Angaben in {} müssen durch Ihre DOCBOX® ersetzt werden.

{HOST}: Hostname oder IP-Adresse Ihrer DOCBOX® einsetzen
{PORT}: PORT Ihrer DOCBOX® einsetzen