Gets status and details about an import process.
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
...
- 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)"StatusCode" 1 = import to be executed, 2 = import in progress, 3 = import completed, 4 = import failed)
| Info |
|---|
| The "mobile" fields refer to text messaging (SMS) and are not part of integrations with third party systems. |
...
SOAP Example
| Code Block |
|---|
| language | html/xml |
|---|
| title | SOAP Request |
|---|
| firstline | 1 |
|---|
| linenumbers | true |
|---|
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.mailupnet.it/">
<soapenv:Header>
<ws:Authentication>
<ws:User>a1234</ws:User>
<ws:Password>mypassword</ws:Password>
<ws:encType>UTF-8</ws:encType>
</ws:Authentication>
</soapenv:Header>
<soapenv:Body>
<ws:GetProcessDetails>
<ws:idList>1</ws:idList>
<ws:listGUID>00000000-aaaa-bbbb-cccc-000123456789</ws:listGUID>
<ws:idProcess>275</ws:idProcess>
</ws:GetProcessDetails>
</soapenv:Body>
</soapenv:Envelope> |
| Code Block |
|---|
| language | html/xml |
|---|
| title | SOAP Response |
|---|
| linenumbers | true |
|---|
|
<mailupMessage>
<mailupBody>
<ReturnCode>0</ReturnCode>
<ImportProcess idProcess="17275">
<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 >
<StartDate>30/10/2012 15.39.12</StartDate>
<EndDate>30/10/2012 15.39.24</EndDate>
<TotalContacts>0</TotalContacts>
<NewMobile>0</NewMobile>
<NewEmail>0</NewEmail>
<OptOutMobile>0</OptOutMobile>
<OptOutEmail>0</OptOutEmail>
<ExistingMobile>0</ExistingMobile>
<ExistingEmail>0</ExistingEmail>
<StatusCode>3</StatusCode>
<IsRunning>False</IsRunning>
<ConfirmationEmail>False</ConfirmationEmail>
<ConfirmationSent></ConfirmationSent>
</ImportProcess>
</mailupBody>
</mailupMessage> |
Error codes
| Error code | Description |
|---|
| -500 | unrecognized error |
| -501 | idProcess not found |
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.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> |