DMWS Web Service

DMWS

Click here for a complete list of operations.

AddMailingListStringForAddressCount

Save a temporary mailing list from a string to obtaining address counts. Returns MailingListGUID that can be passed to PollMailingListAddressCounts to get the address counts.

Test

The test form is only available for requests from the local machine.

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 /DMWS.asmx HTTP/1.1
Host: api.docmail.co.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "APIv2/AddMailingListStringForAddressCount"

<?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>
    <AddMailingListStringForAddressCount xmlns="APIv2">
      <Username>string</Username>
      <Password>string</Password>
      <MailingListData>string</MailingListData>
      <DataFormat>string</DataFormat>
      <HasHeaders>boolean</HasHeaders>
      <SheetName>string</SheetName>
      <MappingDelimiter>string</MappingDelimiter>
      <MappingFixedWidthChars>string</MappingFixedWidthChars>
      <MappingName>string</MappingName>
      <ReturnFormat>string</ReturnFormat>
    </AddMailingListStringForAddressCount>
  </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>
    <AddMailingListStringForAddressCountResponse xmlns="APIv2">
      <AddMailingListStringForAddressCountResult>string</AddMailingListStringForAddressCountResult>
    </AddMailingListStringForAddressCountResponse>
  </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 /DMWS.asmx HTTP/1.1
Host: api.docmail.co.uk
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>
    <AddMailingListStringForAddressCount xmlns="APIv2">
      <Username>string</Username>
      <Password>string</Password>
      <MailingListData>string</MailingListData>
      <DataFormat>string</DataFormat>
      <HasHeaders>boolean</HasHeaders>
      <SheetName>string</SheetName>
      <MappingDelimiter>string</MappingDelimiter>
      <MappingFixedWidthChars>string</MappingFixedWidthChars>
      <MappingName>string</MappingName>
      <ReturnFormat>string</ReturnFormat>
    </AddMailingListStringForAddressCount>
  </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>
    <AddMailingListStringForAddressCountResponse xmlns="APIv2">
      <AddMailingListStringForAddressCountResult>string</AddMailingListStringForAddressCountResult>
    </AddMailingListStringForAddressCountResponse>
  </soap12:Body>
</soap12:Envelope>