SOAP API method PdfDocument_createExport

Back to API references

Description
Export the document for a certain source.

Parameters
Parameter 'id' : int
Unique identifier (id) of the object PdfDocument. The method only applies to the pdfdocument with this id.
Parameter 'personalize_profile' : int
Profile ID for which the object should be personalized
Parameter 'personalize_subprofile' : int
Subprofile ID for which the object should be personalized
Parameter 'personalize_timestamp' : string
The timestamp for the personalization
Parameter 'profile' : int
ID of the profile
Parameter 'subprofile' : int
ID of the subprofile
Parameter 'database' : int
ID of the database
Parameter 'view' : int
ID of the view
Parameter 'collection' : int
ID of the collection
Parameter 'miniview' : int
ID of the miniview
Parameter 'type' : string
The possible values are "zip" and "pdf"
Parameter 'updatehistory' : boolean
Update the history
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'pdfexport' : Structure of type 'pdfexport'

Structure 'login'
This structure login was mentioned above. This structure has the following properties:
Property 'username' : string
The username of the login attempt
Property 'account' : string
The account name of the login attempt
Property 'password' : string
The password for the login attempt

Structure 'pdfexport'
This structure pdfexport was mentioned above. This structure has the following properties:
Property 'id' : int
The ID of the export.
Property 'type' : string
The type of the export.
Property 'status' : string
The status of the export.
Property 'created' : timestamp
The time when the export was created.
Property 'readytime' : timestamp
The time when the export was ready for download.
Property 'totalfiles' : int
The total number of files that are in the exported file.
Property 'avaiablefiles' : int
The number of files that are now available.
Property 'size' : int
The size in bytes of the export.
Property 'humansize' : string
The size in a human readable format.