Client Web Service

Client

Click here for a complete list of operations.

RequestedDeedsDocuments

Use this method to check for requested Deeds Office 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/RequestedDeedsDocuments"

<?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>
    <RequestedDeedsDocuments xmlns="http://server.windeed.co.za/windeedengine/">
      <scope>Company or User or DocumentIdList</scope>
    </RequestedDeedsDocuments>
  </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>
    <RequestedDeedsDocumentsResponse xmlns="http://server.windeed.co.za/windeedengine/">
      <RequestedDeedsDocumentsResult>
        <DeedsOfficeDocumentCopy>
          <ReferenceNumber>int</ReferenceNumber>
          <DateRequested>dateTime</DateRequested>
          <DeedsOffice>NotSpecified or Bloemfontein or CapeTown or Johannesburg or Kimberley or KingWilliamsTown or Mpumalanga or Pietermaritzburg or Pretoria or Umtata or Vryburg or Limpopo</DeedsOffice>
          <DocumentNumber>string</DocumentNumber>
          <MicrofilmReference>string</MicrofilmReference>
          <Username>string</Username>
          <Description>string</Description>
          <DocumentRequests>
            <RequestedDocument xsi:nil="true" />
            <RequestedDocument xsi:nil="true" />
          </DocumentRequests>
          <Reference>string</Reference>
          <TextCopyRequested>boolean</TextCopyRequested>
          <IsOnBackOrder>boolean</IsOnBackOrder>
          <IsCorrupted>boolean</IsCorrupted>
          <IsNotFound>boolean</IsNotFound>
        </DeedsOfficeDocumentCopy>
        <DeedsOfficeDocumentCopy>
          <ReferenceNumber>int</ReferenceNumber>
          <DateRequested>dateTime</DateRequested>
          <DeedsOffice>NotSpecified or Bloemfontein or CapeTown or Johannesburg or Kimberley or KingWilliamsTown or Mpumalanga or Pietermaritzburg or Pretoria or Umtata or Vryburg or Limpopo</DeedsOffice>
          <DocumentNumber>string</DocumentNumber>
          <MicrofilmReference>string</MicrofilmReference>
          <Username>string</Username>
          <Description>string</Description>
          <DocumentRequests>
            <RequestedDocument xsi:nil="true" />
            <RequestedDocument xsi:nil="true" />
          </DocumentRequests>
          <Reference>string</Reference>
          <TextCopyRequested>boolean</TextCopyRequested>
          <IsOnBackOrder>boolean</IsOnBackOrder>
          <IsCorrupted>boolean</IsCorrupted>
          <IsNotFound>boolean</IsNotFound>
        </DeedsOfficeDocumentCopy>
      </RequestedDeedsDocumentsResult>
    </RequestedDeedsDocumentsResponse>
  </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>
    <RequestedDeedsDocuments xmlns="http://server.windeed.co.za/windeedengine/">
      <scope>Company or User or DocumentIdList</scope>
    </RequestedDeedsDocuments>
  </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>
    <RequestedDeedsDocumentsResponse xmlns="http://server.windeed.co.za/windeedengine/">
      <RequestedDeedsDocumentsResult>
        <DeedsOfficeDocumentCopy>
          <ReferenceNumber>int</ReferenceNumber>
          <DateRequested>dateTime</DateRequested>
          <DeedsOffice>NotSpecified or Bloemfontein or CapeTown or Johannesburg or Kimberley or KingWilliamsTown or Mpumalanga or Pietermaritzburg or Pretoria or Umtata or Vryburg or Limpopo</DeedsOffice>
          <DocumentNumber>string</DocumentNumber>
          <MicrofilmReference>string</MicrofilmReference>
          <Username>string</Username>
          <Description>string</Description>
          <DocumentRequests>
            <RequestedDocument xsi:nil="true" />
            <RequestedDocument xsi:nil="true" />
          </DocumentRequests>
          <Reference>string</Reference>
          <TextCopyRequested>boolean</TextCopyRequested>
          <IsOnBackOrder>boolean</IsOnBackOrder>
          <IsCorrupted>boolean</IsCorrupted>
          <IsNotFound>boolean</IsNotFound>
        </DeedsOfficeDocumentCopy>
        <DeedsOfficeDocumentCopy>
          <ReferenceNumber>int</ReferenceNumber>
          <DateRequested>dateTime</DateRequested>
          <DeedsOffice>NotSpecified or Bloemfontein or CapeTown or Johannesburg or Kimberley or KingWilliamsTown or Mpumalanga or Pietermaritzburg or Pretoria or Umtata or Vryburg or Limpopo</DeedsOffice>
          <DocumentNumber>string</DocumentNumber>
          <MicrofilmReference>string</MicrofilmReference>
          <Username>string</Username>
          <Description>string</Description>
          <DocumentRequests>
            <RequestedDocument xsi:nil="true" />
            <RequestedDocument xsi:nil="true" />
          </DocumentRequests>
          <Reference>string</Reference>
          <TextCopyRequested>boolean</TextCopyRequested>
          <IsOnBackOrder>boolean</IsOnBackOrder>
          <IsCorrupted>boolean</IsCorrupted>
          <IsNotFound>boolean</IsNotFound>
        </DeedsOfficeDocumentCopy>
      </RequestedDeedsDocumentsResult>
    </RequestedDeedsDocumentsResponse>
  </soap12:Body>
</soap12:Envelope>