Starts the import process that has been created using NewImportProcess method
Method parameters
StartProcess(int idList, int listGUID, int idProcess)
Starts the import process
- idList: list identifier
- listGuid: GUID of the list
- idProcess: import process ID
If the process cannot be activated the MailUpBody result will contain an appropriate ReturnCode.
Sample ReturnCode
Code Block |
---|
language | html/xml |
---|
linenumbers | true |
---|
|
<mailupMessage>
<mailupBody>
<ReturnCode>0</ReturnCode>
</mailupBody>
</mailupMessage> |
Error codes
Error code | Description |
---|
-600 | unrecognized error |
-601 | an import process is already running for the list |
-602 | an import process is already running for a different list |
-603 | error checking process status |
-604 | error starting the process job |
Ruby Example
Code Block |
---|
|
# Refer to https://mailup.atlassian.net/wiki/display/mailupapi/MailUp+RubyGem for gem information.
require 'mailup'
m = MailUp::Import.new('username', 'password', 'console_url')
m.start_proces(:idList => 123456, :listGuid => 123456, :idProcess => 123)
# => <?xml version=\"1.0\" encoding=\"windows-1252\" ?><mailupMessage><mailupBody><ReturnCode>0</ReturnCode></mailupBody></mailupMessage> |