Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

Gets status and details about an import process.

Method parameters

GetProcessDetails(int idList, string listGUID, int idProcess)

  • 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 ("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
languagehtml/xml
titleSOAP Request
firstline1
linenumberstrue
<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
languagehtml/xml
titleSOAP Response ("Confirmation request" not set by import process)
linenumberstrue
<mailupMessage>
  <mailupBody>
    <ReturnCode>0</ReturnCode>
    <ImportProcess idProcess="275">
      <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 is empty if Confirmation request was not set during import --> 
      <ConfirmationSent></ConfirmationSent>
    </ImportProcess>
  </mailupBody>
</mailupMessage>
Code Block
languagehtml/xml
titleSOAP Response ("Confirmation request" was set by import process but email is still to be sent)
<mailupMessage>
  <mailupBody>
    <ReturnCode>0</ReturnCode>
    <ImportProcess idProcess="4">
      <StartDate>14/06/2013 10.36.19</StartDate>
      <EndDate>14/06/2013 10.36.25</EndDate>
      <TotalContacts>0</TotalContacts>
      <NewMobile>1</NewMobile>
      <NewEmail>1</NewEmail>
      <OptOutMobile>0</OptOutMobile>
      <OptOutEmail>0</OptOutEmail>
      <ExistingMobile>0</ExistingMobile>
      <ExistingEmail>0</ExistingEmail>
      <StatusCode>3</StatusCode>
      <IsRunning>False</IsRunning>
      <ConfirmationEmail>True</ConfirmationEmail>
      <!-- When Confirmation request (double optin) is required the process details will contain ConfirmationEmail=true and ConfirmationSent will have a value (True or False) -->
      <!-- Please note that when you set confirm=1 (true) during import process the confirmation email is not automatically sent, it is simply enqueued. Then you will have to manually send enqueued message by selecting Email > SendStatus > Send Now on your MailUp console -->
      <!-- Value of ConfirmationSent field is False until MailUp user proceeds with manually sending the enqueued confirmation requests -->
      <ConfirmationSent>False</ConfirmationSent>
    </ImportProcess>
</mailupBody>
</mailupMessage>
Code Block
languagehtml/xml
titleSOAP Response ("Confirmation request" was set by import process and email has been sent)
<mailupMessage>
  <mailupBody>
    <ReturnCode>0</ReturnCode>
    <ImportProcess idProcess="4">
      <StartDate>14/06/2013 10.36.19</StartDate>
      <EndDate>14/06/2013 10.36.25</EndDate>
      <TotalContacts>0</TotalContacts>
      <NewMobile>1</NewMobile>
      <NewEmail>1</NewEmail>
      <OptOutMobile>0</OptOutMobile>
      <OptOutEmail>0</OptOutEmail>
      <ExistingMobile>0</ExistingMobile>
      <ExistingEmail>0</ExistingEmail>
      <StatusCode>3</StatusCode>
      <IsRunning>False</IsRunning>
      <ConfirmationEmail>True</ConfirmationEmail>
      <!-- User has manually sent enqueued confirmation messages -->
      <ConfirmationSent>True</ConfirmationSent>
    </ImportProcess>
  </mailupBody>
</mailupMessage>


Error codes

Error codeDescription
-500unrecognized error
-501idProcess not found

Ruby Example

Code Block
languageruby
# 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>