SOAP API methode PdfDocument_createExport

Terug naar de indexpagina

Beschrijving
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'

Structuur 'login'
De structuur 'login' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'username' : string
The username of the login attempt
Eigenschap 'account' : string
The account name of the login attempt
Eigenschap 'password' : string
The password for the login attempt

Structuur 'pdfexport'
De structuur 'pdfexport' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'id' : int
The ID of the export.
Eigenschap 'type' : string
The type of the export.
Eigenschap 'status' : string
The status of the export.
Eigenschap 'created' : timestamp
The time when the export was created.
Eigenschap 'readytime' : timestamp
The time when the export was ready for download.
Eigenschap 'totalfiles' : int
The total number of files that are in the exported file.
Eigenschap 'avaiablefiles' : int
The number of files that are now available.
Eigenschap 'size' : int
The size in bytes of the export.
Eigenschap 'humansize' : string
The size in a human readable format.