SOAP API method PdfDocument_copy

Back to API references

Description
Copy the document and return a newly created document

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 'name' : string
Name of the new document
Parameter 'webtemplate' : Structure of type 'webtemplate'
template to copy the document to
Parameter 'emailingtemplate' : Structure of type 'emailingtemplate'
template to copy the document to
Parameter 'pdftemplate' : Structure of type 'pdftemplate'
template to copy the document to
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'pdfdocument' : Structure of type 'pdfdocument'
Return value 'smsdocument' : Structure of type 'smsdocument'
Return value 'emailingdocument' : Structure of type 'emailingdocument'
Return value 'webdocument' : Structure of type 'webdocument'

Structure 'webtemplate'
This structure webtemplate was mentioned above. This structure has the following properties:
Property 'charset' : string
The charset of the htmltemplate.
Property 'htmlEscaping' : string
Check if the template is escaping HTML code
Property 'smartyVersion' : integer
What smarty version is used to render this template
Property 'upgradeSmartyVersion' : integer
Upgrade smartyversion 2 to 3
Property 'id' : int
The ID of the template.
Property 'name' : string
The name of the template.
Property 'description' : string
The description of the template.
Property 'archived' : boolean
The template is archived.
Property 'created' : timestamp
When the template was created.
Property 'modified' : timestamp
When the template was last modified.
Property 'language' : string
The language of the template.
Property 'timezone' : string
Get the timezone of the template

Structure 'emailingtemplate'
This structure emailingtemplate was mentioned above. This structure has the following properties:
Property 'convertedid' : int
The converted ID of the emailingtemplate.
Property 'headers' : string
The additional headers of the emailingtemplate.
Property 'textversion' : string
The textversion of the template.
Property 'useinlinestyles' : string
Should stylesheets in document based on the template be merged into inline
Property 'priority_indicator' : string
Getting the priority header for emails who use this template
Property 'unsubscribe_header' : string
Should the list-unsubscribe header be sent with the mailing.
Property 'fromaddress' : EmailAddress
The fromaddress of the emailingtemplate.
Property 'bccaddress' : EmailAddress
The default bcc address of this emailing template.
Property 'replytoaddress' : EmailAddress
The default reply-to address of the emailing template.
Property 'charset' : string
The charset of the htmltemplate.
Property 'htmlEscaping' : string
Check if the template is escaping HTML code
Property 'smartyVersion' : integer
What smarty version is used to render this template
Property 'upgradeSmartyVersion' : integer
Upgrade smartyversion 2 to 3
Property 'id' : int
The ID of the template.
Property 'name' : string
The name of the template.
Property 'description' : string
The description of the template.
Property 'archived' : boolean
The template is archived.
Property 'created' : timestamp
When the template was created.
Property 'modified' : timestamp
When the template was last modified.
Property 'language' : string
The language of the template.
Property 'timezone' : string
Get the timezone of the template

Structure 'pdftemplate'
This structure pdftemplate was mentioned above. This structure has the following properties:
Property 'hashcode' : string
Hashcode of the template
Property 'source' : binary
The source of the template. The data is base64 encoded.
Property 'pagecount' : int
The number of pages of the template.
Property 'size' : int
The size of the template.
Property 'id' : int
The ID of the template.
Property 'name' : string
The name of the template.
Property 'description' : string
The description of the template.
Property 'archived' : boolean
The template is archived.
Property 'created' : timestamp
When the template was created.
Property 'modified' : timestamp
When the template was last modified.
Property 'language' : string
The language of the template.
Property 'timezone' : string
Get the timezone of the template

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 'pdfdocument'
This structure pdfdocument was mentioned above. This structure has the following properties:
Property 'status' : string
Status of the document.
Property 'pagecount' : int
The number of pages in the document.
Property 'size' : int
The size of the document.
Property 'faxheader' : string
The headerline above the fax.
Property 'temporary' : boolean
Is this document set as a temporary document. The document will be removed when there are no
Property 'id' : int
The ID of the document.
Property 'templateID' : int
The template ID of the document
Property 'name' : string
The name of the document.
Property 'description' : string
The description of the document.
Property 'archived' : boolean
Is this an archived document?.
Property 'created' : timestamp
The date and time when the document was created.
Property 'modified' : timestamp
The date and time when the document was last modified.
Property 'language' : string
The language of the document.
Property 'timezone' : string
Get the time zone of the document. If the timezone is not set, it returns

Structure 'smsdocument'
This structure smsdocument was mentioned above. This structure has the following properties:
Property 'from' : string
The from address of the sms document.
Property 'message' : string
The message of the sms.
Property 'temporary' : boolean
Is this document set as a temporary document. The document will be removed when there are no
Property 'size' : int
Get the size of the document.
Property 'smartyVersion' : integer
What smarty version is used to render this document
Property 'id' : int
The ID of the document.
Property 'templateID' : int
The template ID of the document
Property 'name' : string
The name of the document.
Property 'description' : string
The description of the document.
Property 'archived' : boolean
Is this an archived document?.
Property 'created' : timestamp
The date and time when the document was created.
Property 'modified' : timestamp
The date and time when the document was last modified.
Property 'language' : string
The language of the document.
Property 'timezone' : string
Get the time zone of the document. If the timezone is not set, it returns

Structure 'emailingdocument'
This structure emailingdocument was mentioned above. This structure has the following properties:
Property 'convertedid' : int
The converted ID.
Property 'headers' : string
The additional headers.
Property 'subject' : string
The subject of the emailingdocument.
Property 'fromaddress' : EmailAddress
The fromaddress of the emailingdocument.
Property 'fromaddressstatus' : string
Get the status of the from address. When a from address is okay to do
Property 'bccaddress' : EmailAddress
The bccaddress of this emailingdocument.
Property 'replytoaddress' : EmailAddress
The reply-to address of the emailingdocument.
Property 'textversion' : string
The textversion of the emailingdocument.
Property 'useinlinestyles' : string
Should stylesheets in the document be merged into inline styles? This is usefull
Property 'temporary' : boolean
Is this document set as a temporary document. The document will be removed when there are no
Property 'priority_indicator' : string
Getting the priority header for emails who use this document
Property 'unsubscribe_header' : string
Should the list-unsubscribe header be sent with the mailing.
Property 'charset' : string
Gets the charset that should be used when showing/sending this document
Property 'htmlEscaping' : string
Check if the document is escaping HTML code
Property 'smartyVersion' : integer
What smarty version is used to render this document
Property 'id' : int
The ID of the document.
Property 'templateID' : int
The template ID of the document
Property 'name' : string
The name of the document.
Property 'description' : string
The description of the document.
Property 'archived' : boolean
Is this an archived document?.
Property 'created' : timestamp
The date and time when the document was created.
Property 'modified' : timestamp
The date and time when the document was last modified.
Property 'language' : string
The language of the document.
Property 'timezone' : string
Get the time zone of the document. If the timezone is not set, it returns

Structure 'webdocument'
This structure webdocument was mentioned above. This structure has the following properties:
Property 'loginrequired' : boolean
The page is only available for logged in profiles or subprofiles.
Property 'enabled' : boolean
Page enabled.
Property 'charset' : string
Gets the charset that should be used when showing/sending this document
Property 'htmlEscaping' : string
Check if the document is escaping HTML code
Property 'smartyVersion' : integer
What smarty version is used to render this document
Property 'id' : int
The ID of the document.
Property 'templateID' : int
The template ID of the document
Property 'name' : string
The name of the document.
Property 'description' : string
The description of the document.
Property 'archived' : boolean
Is this an archived document?.
Property 'created' : timestamp
The date and time when the document was created.
Property 'modified' : timestamp
The date and time when the document was last modified.
Property 'language' : string
The language of the document.
Property 'timezone' : string
Get the time zone of the document. If the timezone is not set, it returns