Client


Click here for a complete list of operations.

RetrieveDocuments

Use this method to download Deeds Document copies.

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 /windeedengine3/client.asmx HTTP/1.1
Host: server.windeed.co.za
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://server.windeed.co.za/windeedengine/RetrieveDocuments"

<?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:Header>
    <EmailCredentials xmlns="http://server.windeed.co.za/windeedengine/">
      <EmailAddress>string</EmailAddress>
      <Password>string</Password>
      <Requester>string</Requester>
    </EmailCredentials>
    <TokenCredentials xmlns="http://server.windeed.co.za/windeedengine/">
      <SerializedToken>string</SerializedToken>
      <Requester>string</Requester>
    </TokenCredentials>
    <WinDeedCredentials xmlns="http://server.windeed.co.za/windeedengine/">
      <Username>string</Username>
      <Password>string</Password>
      <Company>string</Company>
      <Requester>string</Requester>
    </WinDeedCredentials>
  </soap:Header>
  <soap:Body>
    <RetrieveDocuments xmlns="http://server.windeed.co.za/windeedengine/">
      <referenceNumbers>
        <int>int</int>
        <int>int</int>
      </referenceNumbers>
      <requiredFormat>Pdf or Rtf or Tif or Tiff</requiredFormat>
    </RetrieveDocuments>
  </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>
    <RetrieveDocumentsResponse xmlns="http://server.windeed.co.za/windeedengine/">
      <RetrieveDocumentsResult>
        <DocumentCopyItem>
          <ReferenceNumber>int</ReferenceNumber>
          <DocumentFormat>Pdf or Rtf or Tif or Tiff</DocumentFormat>
          <DocumentData>base64Binary</DocumentData>
        </DocumentCopyItem>
        <DocumentCopyItem>
          <ReferenceNumber>int</ReferenceNumber>
          <DocumentFormat>Pdf or Rtf or Tif or Tiff</DocumentFormat>
          <DocumentData>base64Binary</DocumentData>
        </DocumentCopyItem>
      </RetrieveDocumentsResult>
    </RetrieveDocumentsResponse>
  </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 /windeedengine3/client.asmx HTTP/1.1
Host: server.windeed.co.za
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:Header>
    <EmailCredentials xmlns="http://server.windeed.co.za/windeedengine/">
      <EmailAddress>string</EmailAddress>
      <Password>string</Password>
      <Requester>string</Requester>
    </EmailCredentials>
    <TokenCredentials xmlns="http://server.windeed.co.za/windeedengine/">
      <SerializedToken>string</SerializedToken>
      <Requester>string</Requester>
    </TokenCredentials>
    <WinDeedCredentials xmlns="http://server.windeed.co.za/windeedengine/">
      <Username>string</Username>
      <Password>string</Password>
      <Company>string</Company>
      <Requester>string</Requester>
    </WinDeedCredentials>
  </soap12:Header>
  <soap12:Body>
    <RetrieveDocuments xmlns="http://server.windeed.co.za/windeedengine/">
      <referenceNumbers>
        <int>int</int>
        <int>int</int>
      </referenceNumbers>
      <requiredFormat>Pdf or Rtf or Tif or Tiff</requiredFormat>
    </RetrieveDocuments>
  </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>
    <RetrieveDocumentsResponse xmlns="http://server.windeed.co.za/windeedengine/">
      <RetrieveDocumentsResult>
        <DocumentCopyItem>
          <ReferenceNumber>int</ReferenceNumber>
          <DocumentFormat>Pdf or Rtf or Tif or Tiff</DocumentFormat>
          <DocumentData>base64Binary</DocumentData>
        </DocumentCopyItem>
        <DocumentCopyItem>
          <ReferenceNumber>int</ReferenceNumber>
          <DocumentFormat>Pdf or Rtf or Tif or Tiff</DocumentFormat>
          <DocumentData>base64Binary</DocumentData>
        </DocumentCopyItem>
      </RetrieveDocumentsResult>
    </RetrieveDocumentsResponse>
  </soap12:Body>
</soap12:Envelope>