DMWS


Click here for a complete list of operations.

AddTemplateFile

Add a template file to a mailing.

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

<?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>
    <AddTemplateFile xmlns="APIv2">
      <Username>string</Username>
      <Password>string</Password>
      <MailingGUID>guid</MailingGUID>
      <TemplateName>string</TemplateName>
      <FileName>string</FileName>
      <FileData>base64Binary</FileData>
      <DocumentType>string</DocumentType>
      <AddressedDocument>boolean</AddressedDocument>
      <AddressFontCode>string</AddressFontCode>
      <TemplateType>string</TemplateType>
      <BackgroundName>string</BackgroundName>
      <CanBeginOnBack>boolean</CanBeginOnBack>
      <NextTemplateCanBeginOnBack>boolean</NextTemplateCanBeginOnBack>
      <ProtectedAreaPassword>string</ProtectedAreaPassword>
      <EncryptionPassword>string</EncryptionPassword>
      <BleedSupplied>boolean</BleedSupplied>
      <Copies>int</Copies>
      <Instances>int</Instances>
      <InstancePageNumbers>string</InstancePageNumbers>
      <CycleInstancesOnCopies>boolean</CycleInstancesOnCopies>
      <ReturnFormat>string</ReturnFormat>
    </AddTemplateFile>
  </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>
    <AddTemplateFileResponse xmlns="APIv2">
      <AddTemplateFileResult>string</AddTemplateFileResult>
    </AddTemplateFileResponse>
  </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>
    <AddTemplateFile xmlns="APIv2">
      <Username>string</Username>
      <Password>string</Password>
      <MailingGUID>guid</MailingGUID>
      <TemplateName>string</TemplateName>
      <FileName>string</FileName>
      <FileData>base64Binary</FileData>
      <DocumentType>string</DocumentType>
      <AddressedDocument>boolean</AddressedDocument>
      <AddressFontCode>string</AddressFontCode>
      <TemplateType>string</TemplateType>
      <BackgroundName>string</BackgroundName>
      <CanBeginOnBack>boolean</CanBeginOnBack>
      <NextTemplateCanBeginOnBack>boolean</NextTemplateCanBeginOnBack>
      <ProtectedAreaPassword>string</ProtectedAreaPassword>
      <EncryptionPassword>string</EncryptionPassword>
      <BleedSupplied>boolean</BleedSupplied>
      <Copies>int</Copies>
      <Instances>int</Instances>
      <InstancePageNumbers>string</InstancePageNumbers>
      <CycleInstancesOnCopies>boolean</CycleInstancesOnCopies>
      <ReturnFormat>string</ReturnFormat>
    </AddTemplateFile>
  </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>
    <AddTemplateFileResponse xmlns="APIv2">
      <AddTemplateFileResult>string</AddTemplateFileResult>
    </AddTemplateFileResponse>
  </soap12:Body>
</soap12:Envelope>