| Status | ||||
|---|---|---|---|---|
|
| Table of Contents |
|---|
Endpoints
SOAP: http://services.mailupnet.it/1.0/MailUpService.svc
REST: http://services.mailupnet.it/1.0/MailUpService.svc/rest
Methods
| Category | Description | Available methods |
|---|---|---|
| Authentication | Login and logout methods. Login returns an access key that can be used as parameter when calling other methods |
...
| Filters | Create and delete MailUp filters. | |
| Test | This |
...
| group includes methods that can be used to test the service |
|
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 Element | Description |
|---|---|
| <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. |
FaultCodes
| Error | Description |
|---|---|
| VersionMismatch | Found an invalid namespace for the SOAP Envelope element |
| MustUnderstand | An immediate child element of the Header element, with the mustUnderstand attribute set to "1", was not understood |
| Client | The message was incorrectly formed or contained incorrect information |
| Server | There 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 | ||
|---|---|---|
| ||
<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> |
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).
Restrictions
- Available REST methods cannot be called using HTTP GET ("Ping" test method is the only exception, which can be called using http GET http://services.mailupnet.it/1.0/MailUpService.svc/rest/Ping)
- JSON is not supported
| Warning |
|---|
Any client implementation that performs authentication to MailUp API using REST from a client-side script (e.g. by calling AuthenticationLogin from a Javascript page) may expose your credentials to hacking. |
Configuration
| 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:
| Code Block | ||
|---|---|---|
| ||
<LoginRequest> <Username>xxxx</Username> <Password>yyyy</Password> <IdConsole>10001</IdConsole> </LoginRequest> |
...
A successful response has this format:
...
while "HTTP 400 Bad Request" is returned in case of unsuccessful response
More details
| Child pages (Children Display) | ||
|---|---|---|
|