SOAP API methode PdfDocument_createFaxMailing

Terug naar de indexpagina

Beschrijving
Create a fax mailing based on this pdfdocument.

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 'faxmailingsettings' : Structure of type 'faxmailingsettings'
The settings of the mailing
Parameter 'login' : Structure of type 'login'
Optional login data

Return values
Return value 'processedfaxmailing' : Structure of type 'processedfaxmailing'
Return value 'scheduledfaxmailing' : Structure of type 'scheduledfaxmailing'

Structuur 'faxmailingsettings'
De structuur 'faxmailingsettings' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'registerstatus' : boolean
Get if the status should be registered for the mailing?
Eigenschap 'starttime' : timestamp
The starttime of the mailing.
Eigenschap 'dateinterval' : DateInterval
The interval for the mailing.
Eigenschap 'iterations' : int
The iterations of the settings.
Eigenschap 'description' : string
The description of the mailing.
Eigenschap 'processedmissediterations' : boolean
The processed missed iterations.
Eigenschap 'personalized' : boolean
Should the mailing be personalized?.
Eigenschap 'test' : boolean
Is this a test mailing?.
Eigenschap 'nodoubles' : boolean
Should the double addresses be skipped?.
Eigenschap 'messagesperminute' : int
The max number of messages that are sent withing one minute
Eigenschap 'isscheduled' : boolean
Is the mailing a scheduled mailing?.
Eigenschap 'extradocumentproperties' : Map
Get the extra document properties of this mailing. This doen't contain the
Eigenschap 'priority' : int
The priority settings of the mailing.

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 'processedfaxmailing'
De structuur 'processedfaxmailing' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'registerstatus.' : boolean
Will the status be registered?
Eigenschap 'destinationcount' : int
The number of destinations of the faxmailing.
Eigenschap 'id' : int
Get the ID of the mailing.
Eigenschap 'timestamp' : timestamp
The timestamp when the mailing was sent.
Eigenschap 'description' : string
The description of the mailing.
Eigenschap 'personalized' : boolean
Was this mailing personalized?.
Eigenschap 'nodoubles' : boolean
Should the mailing be send to double mailaddresses?.
Eigenschap 'individual' : boolean
Was this mailing sent to an individual?.
Eigenschap 'test' : boolean
Was this mailing a test?
Eigenschap 'type' : string
The type of the mailing.
Eigenschap 'messagesperminute' : int
The max number of messages that are sent withing one minute
Eigenschap 'archived' : boolean
The mailing is archived.
Eigenschap 'priority' : int
Priority of the mailing. Higher value indicates higher priority.

Structuur 'scheduledfaxmailing'
De structuur 'scheduledfaxmailing' is hierboven vermeld. Deze structuur heeft de volgende properties:
Eigenschap 'registerstatus' : boolean
Will the status be registered?.
Eigenschap 'description' : string
The description of the scheduled mailing
Eigenschap 'test' : boolean
Was this a test mailing?.
Eigenschap 'personalized' : boolean
Was this mailing personalized?.
Eigenschap 'nodoubles' : boolean
Was the target contains doubles?.
Eigenschap 'messagesperminute' : int
The max number of messages that are sent withing one minute
Eigenschap 'priority' : int
Priority of the mailing. Higher value indicated higher priority.
Eigenschap 'nextstarttime' : timestamp
The next time when this scheduled event will run.
Eigenschap 'schedulediterations' : int
The number of iterations that are still remaining.
Eigenschap 'processediterations' : int
The number of iterations that were already processed.
Eigenschap 'previousstarttime' : string
The starttime of the last iteration.
Eigenschap 'processmissediterations' : boolean
Will the missed iterations be processed anyway?.
Eigenschap 'id' : int
The ID of the scheduledevent.