DMWS


Click here for a complete list of operations.

AddTemplateBackgroundRule

Add a template background rule.

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

<?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>
    <AddTemplateBackgroundRule xmlns="APIv2">
      <Username>string</Username>
      <Password>string</Password>
      <MailingGUID>guid</MailingGUID>
      <TemplateGUID>guid</TemplateGUID>
      <BackgroundName>string</BackgroundName>
      <AndGroup>string</AndGroup>
      <AddressField>string</AddressField>
      <DataFormat>string</DataFormat>
      <FromEquation>string</FromEquation>
      <FromData>string</FromData>
      <ToEquation>string</ToEquation>
      <ToData>string</ToData>
      <ReturnFormat>string</ReturnFormat>
    </AddTemplateBackgroundRule>
  </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>
    <AddTemplateBackgroundRuleResponse xmlns="APIv2">
      <AddTemplateBackgroundRuleResult>string</AddTemplateBackgroundRuleResult>
    </AddTemplateBackgroundRuleResponse>
  </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>
    <AddTemplateBackgroundRule xmlns="APIv2">
      <Username>string</Username>
      <Password>string</Password>
      <MailingGUID>guid</MailingGUID>
      <TemplateGUID>guid</TemplateGUID>
      <BackgroundName>string</BackgroundName>
      <AndGroup>string</AndGroup>
      <AddressField>string</AddressField>
      <DataFormat>string</DataFormat>
      <FromEquation>string</FromEquation>
      <FromData>string</FromData>
      <ToEquation>string</ToEquation>
      <ToData>string</ToData>
      <ReturnFormat>string</ReturnFormat>
    </AddTemplateBackgroundRule>
  </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>
    <AddTemplateBackgroundRuleResponse xmlns="APIv2">
      <AddTemplateBackgroundRuleResult>string</AddTemplateBackgroundRuleResult>
    </AddTemplateBackgroundRuleResponse>
  </soap12:Body>
</soap12:Envelope>