Method parameters
GetProcessDetails(int idList, int listGUID, int idProcess)
Gets status and details about an import process.
- idList: list identifier
- listGuid: GUID of the list
- idProcess: import process ID
ReturnCode=0 for successful requests, otherwise a negative value is returned.
Returned results contains the following information:
- start date
- end date
- number of contacts to be imported
- number of imported contacts (grouped by status: New, Existing, Optout)
- process status (running, completed, waiting, error)
The "mobile" fields refer to text messaging (SMS) and are not part of integrations with third party systems.
Sample GetProcessDetails response
<mailupMessage> <mailupBody> <ReturnCode>0</ReturnCode> <ImportProcess idProcess="17"> <StartDate>2008-01-16</StartDate> <EndDate></EndDate> <TotalContacts>10000</TotalContacts> <NewMobile>4500</ NewMobile > <NewEmail>1000</NewEmail> <OptOutMobile>15</OptOut> <OptOutEmail>15</OptOut> <ExistingMobile>100</ExistingMobile> <ExistingEmail>150</ExistingEmail> <StatusCode>2</StatusCode> </ ImportProcess > </mailupBody> </mailupMessage>
Error codes
Error code | Description |
---|---|
-500 | unrecognized error |
-501 | idProcess not found |
Ruby Example
# 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.get_process_details(:idList => 123456, :listGuid => 123456, :idProcess => 123) # => <?xml version=\"1.0\" encoding=\"windows-1252\" ?><mailupMessage><mailupBody><ReturnCode>0</ReturnCode><ImportProcess idProcess="17">...</ImportProcess></mailupBody></mailupMessage>