Back to API references

SOAP API method PdfDocument_export

Description

An individual export of the pdfdocument.

Parameters

Name Type Description
id * int Unique identifier (id) of the object PdfDocument. The method only applies to the pdfdocument with this id.
personalize_profile int Profile ID for which the object should be personalized
personalize_subprofile int Subprofile ID for which the object should be personalized
personalize_timestamp string The timestamp for the personalization
identifier * int
login Structure of type 'login' Optional login data (soon deprecated)
access_token string Optional api access token
* required parameters

Return values

Name Type Description
pdfexport Structure of type 'pdfexport'

Structure 'login'

Name Type Description
username string The username of the login attempt
account string The account name of the login attempt
password string The password for the login attempt

Structure 'pdfexport'

Name Type Description
id int The ID of the export.
type string The type of the export.
status string The status of the export.
created timestamp The time when the export was created.
readytime timestamp The time when the export was ready for download.
totalfiles int The total number of files that are in the exported file.
avaiablefiles int The number of files that are now available.
size int The size in bytes of the export.
humansize string The size in a human readable format.