DMWS


Click here for a complete list of operations.

ListMailings

Get a list of mailings.

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/ListMailings"

<?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>
    <ListMailings xmlns="APIv2">
      <Username>string</Username>
      <Password>string</Password>
      <ProductType>string</ProductType>
      <SubmittedFrom>dateTime</SubmittedFrom>
      <SubmittedTo>dateTime</SubmittedTo>
      <SearchText>string</SearchText>
      <OutstandingOnly>boolean</OutstandingOnly>
      <AllUsers>boolean</AllUsers>
      <CanContentApproveOnly>boolean</CanContentApproveOnly>
      <CanBudgetApproveOnly>boolean</CanBudgetApproveOnly>
      <CustomerApplication>string</CustomerApplication>
      <PageSize>int</PageSize>
      <PageNumber>int</PageNumber>
      <SortColumn>string</SortColumn>
      <SortDescending>boolean</SortDescending>
      <ListFormat>string</ListFormat>
      <FailureReturnFormat>string</FailureReturnFormat>
    </ListMailings>
  </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>
    <ListMailingsResponse xmlns="APIv2">
      <ListMailingsResult>string</ListMailingsResult>
    </ListMailingsResponse>
  </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>
    <ListMailings xmlns="APIv2">
      <Username>string</Username>
      <Password>string</Password>
      <ProductType>string</ProductType>
      <SubmittedFrom>dateTime</SubmittedFrom>
      <SubmittedTo>dateTime</SubmittedTo>
      <SearchText>string</SearchText>
      <OutstandingOnly>boolean</OutstandingOnly>
      <AllUsers>boolean</AllUsers>
      <CanContentApproveOnly>boolean</CanContentApproveOnly>
      <CanBudgetApproveOnly>boolean</CanBudgetApproveOnly>
      <CustomerApplication>string</CustomerApplication>
      <PageSize>int</PageSize>
      <PageNumber>int</PageNumber>
      <SortColumn>string</SortColumn>
      <SortDescending>boolean</SortDescending>
      <ListFormat>string</ListFormat>
      <FailureReturnFormat>string</FailureReturnFormat>
    </ListMailings>
  </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>
    <ListMailingsResponse xmlns="APIv2">
      <ListMailingsResult>string</ListMailingsResult>
    </ListMailingsResponse>
  </soap12:Body>
</soap12:Envelope>