CustomerApi Web Service

CustomerApi

Click here for a complete list of operations.

SMGetAllAliases

Gets a list of all the SmarterMail aliases associated with the given 'domainName'.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /1.0/customerapi.asmx HTTP/1.1
Host: api.discountasp.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.discountasp.net/SMGetAllAliases"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SMGetAllAliases xmlns="http://api.discountasp.net/">
      <key>string</key>
      <domainName>string</domainName>
    </SMGetAllAliases>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SMGetAllAliasesResponse xmlns="http://api.discountasp.net/">
      <SMGetAllAliasesResult>
        <SMAlias>
          <EmailAddress>string</EmailAddress>
          <Addresses>
            <string>string</string>
            <string>string</string>
          </Addresses>
        </SMAlias>
        <SMAlias>
          <EmailAddress>string</EmailAddress>
          <Addresses>
            <string>string</string>
            <string>string</string>
          </Addresses>
        </SMAlias>
      </SMGetAllAliasesResult>
    </SMGetAllAliasesResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /1.0/customerapi.asmx HTTP/1.1
Host: api.discountasp.net
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SMGetAllAliases xmlns="http://api.discountasp.net/">
      <key>string</key>
      <domainName>string</domainName>
    </SMGetAllAliases>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SMGetAllAliasesResponse xmlns="http://api.discountasp.net/">
      <SMGetAllAliasesResult>
        <SMAlias>
          <EmailAddress>string</EmailAddress>
          <Addresses>
            <string>string</string>
            <string>string</string>
          </Addresses>
        </SMAlias>
        <SMAlias>
          <EmailAddress>string</EmailAddress>
          <Addresses>
            <string>string</string>
            <string>string</string>
          </Addresses>
        </SMAlias>
      </SMGetAllAliasesResult>
    </SMGetAllAliasesResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /1.0/customerapi.asmx/SMGetAllAliases?key=string&domainName=string HTTP/1.1
Host: api.discountasp.net

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfSMAlias xmlns="http://api.discountasp.net/">
  <SMAlias>
    <EmailAddress>string</EmailAddress>
    <Addresses>
      <string>string</string>
      <string>string</string>
    </Addresses>
  </SMAlias>
  <SMAlias>
    <EmailAddress>string</EmailAddress>
    <Addresses>
      <string>string</string>
      <string>string</string>
    </Addresses>
  </SMAlias>
</ArrayOfSMAlias>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /1.0/customerapi.asmx/SMGetAllAliases HTTP/1.1
Host: api.discountasp.net
Content-Type: application/x-www-form-urlencoded
Content-Length: length

key=string&domainName=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfSMAlias xmlns="http://api.discountasp.net/">
  <SMAlias>
    <EmailAddress>string</EmailAddress>
    <Addresses>
      <string>string</string>
      <string>string</string>
    </Addresses>
  </SMAlias>
  <SMAlias>
    <EmailAddress>string</EmailAddress>
    <Addresses>
      <string>string</string>
      <string>string</string>
    </Addresses>
  </SMAlias>
</ArrayOfSMAlias>

Parameter	Value
key:
domainName: