Page tree
Skip to end of metadata
Go to start of metadata

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) 

     

The "mobile" fields refer to text messaging (SMS) and are not part of integrations with third party systems.

SOAP Example

SOAP Request
<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>
SOAP Response ("Confirmation request" not set by import process)
<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>
SOAP 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>
SOAP 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

# 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>
  • No labels

8 Comments

  1. Anonymous

    what are the values of "StatusCode"?

    0,1,2,3? 1,2,3,4?

    what does <StatusCode>2</StatusCode> mean?
    1. Please read above the list of available status codes

  2. Anonymous

    If I get StatusCode = 4 (Import error) can I have a detail of the error ?

    1. If you previously called StartImportProcesses() the error detail should be nested in the response of that method. This could be helpful for errors that can be discovered while configuring starting the import process, for errors occurred during import execution you may find some other details on MailUp admin console ("Maintenance" or "Import Status" pages).
      Hope this helps, otherwise you can send an email to MailUp support providing all the details that allow to reproduce the error condition. Regards

  3. Anonymous

    What's the meaning of the ConfirmationSent returned field?

    1. A brief explanation has been provided by extending the examples. Hope this helps.

      Regards

  4. Anonymous

    GetProcessDetails(int idList, int listGUID, int idProcess)

    listGUID is string, it is not an int

    1. Hi, we've just updated the documentation. Thank you for your help