DMWS


Click here for a complete list of operations.

AddBackgroundFileToLibrary

Add a background file to the library. Overwrites the existing background if it already exists.

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

<?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>
    <AddBackgroundFileToLibrary xmlns="APIv2">
      <Username>string</Username>
      <Password>string</Password>
      <BackgroundName>string</BackgroundName>
      <DocumentType>string</DocumentType>
      <FileName>string</FileName>
      <FileData>base64Binary</FileData>
      <EncryptionPassword>string</EncryptionPassword>
      <ReturnFormat>string</ReturnFormat>
    </AddBackgroundFileToLibrary>
  </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>
    <AddBackgroundFileToLibraryResponse xmlns="APIv2">
      <AddBackgroundFileToLibraryResult>string</AddBackgroundFileToLibraryResult>
    </AddBackgroundFileToLibraryResponse>
  </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>
    <AddBackgroundFileToLibrary xmlns="APIv2">
      <Username>string</Username>
      <Password>string</Password>
      <BackgroundName>string</BackgroundName>
      <DocumentType>string</DocumentType>
      <FileName>string</FileName>
      <FileData>base64Binary</FileData>
      <EncryptionPassword>string</EncryptionPassword>
      <ReturnFormat>string</ReturnFormat>
    </AddBackgroundFileToLibrary>
  </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>
    <AddBackgroundFileToLibraryResponse xmlns="APIv2">
      <AddBackgroundFileToLibraryResult>string</AddBackgroundFileToLibraryResult>
    </AddBackgroundFileToLibraryResponse>
  </soap12:Body>
</soap12:Envelope>