Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This method can be used to test the service

  • Ping

 

Using SOAP

As specified in WSDL, SOAP methods receives a specific "request" object as input parameter and return a specific "response" object. Please refer to the description of each method for more details.

Error Handling

In case of error a standard SOAP Fault object is returned

Fault Element structure

Sub ElementDescription
<faultcode>A code for identifying the fault
<faultstring>A human readable explanation of the fault
<faultactor>Information about who caused the fault to happen
<detail>

Holds application specific error information related to the Body element.
MailUpService returns a MailUpFaultDetail object, which is composed of ErrorCode and ErrorDesc fields

FaultCodes

ErrorDescription
VersionMismatchFound an invalid namespace for the SOAP Envelope element
MustUnderstandAn immediate child element of the Header element, with the mustUnderstand attribute set to "1", was not understood
ClientThe message was incorrectly formed or contained incorrect information
ServerThere was a problem with the server so the message could not proceed

Example

Here below you can find an example of SOAP Fault for authentication request

Code Block
languagehtml/xml
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <s:Fault>
         <faultcode>s:Client</faultcode>
         <faultstring xml:lang="en-US">Login failed</faultstring>
         <detail>
            <MailUpFaultDetail xmlns="http://Mailup.WS.Schema/Fault" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
               <ErrorCode>1000</ErrorCode>
               <ErrorDesc>Wrong credentials</ErrorDesc>
            </MailUpFaultDetail>
         </detail>
      </s:Fault>
   </s:Body>
</s:Envelope>

 

 (more on this)

Using REST

REST is supported only when XML parameters are passed with http POST method (Ping method is the only exception, which can be called using http GET http://services.mailupnet.it/1.0/MailUpService.svc/rest/Ping).
Required parameter format is the same as what is specified for SOAP requests (see example below).

...

Info

Please refer to REST configuration page to get some tips about enabling REST

Example

Call http://services.mailupnet.it/1.0/MailUpService.svc/rest/AuthenticationLogin passing the following XML as parameter in HTTP POST:

...