Advantez

RetrieveRentalFiles request and response SOAP examples

retrieveRentalFiles

Retrieve details of all files associated to a single rental.

Support Operations

SOAP 1.1

An example of a SOAP 1.1 request and response

POST /webkits/rental.v1.4.service HTTP/1.1
Host: services.advantez.com
Content-Type: text/xml; charset=utf-8
Content-Length: length SOAPAction: "http://services.advantez.com/webkits/rental/v1.4/retrieveRentalFiles"

<?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>
    <retrieveRentalFiles xmlns="http://services.advantez.com/webkits/rental/v1.4">
      <advantezKey>string</advantezKey>
      <webServiceKey>string</webServiceKey>
      <propertyId>int</propertyId>
    </retrieveRentalFiles>
  </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>
    <retrieveRentalFilesResponse xmlns="http://services.advantez.com/webkits/rental/v1.4">
      <retrieveRentalFilesResult>
        <file>
          <url>string</url>
          <description>string</description>
          <type>image or pdf or msword or msexcel or text or virtual-tour or floor-plan or epc-chart</type>
        </file>
        <file>
          <url>string</url>
          <description>string</description>
          <type>image or pdf or msword or msexcel or text or virtual-tour or floor-plan or epc-chart</type>
        </file>
      </retrieveRentalFilesResult>
      <result>successful or invalid-proptrack-key or unauthorised-domain or invalid-webservice-key or unexpected-exception or non-secure-protocol or option-not-support or insufficient-permission or invalid-parameter or invalid-advantez-key or rental-unavailable-for-dates or rental-unavailable-for-term</result>
    </retrieveRentalFilesResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

An example of a SOAP 1.2 request and response

POST /webkits/rental.v1.4.service HTTP/1.1
Host: services.advantez.com
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>
    <retrieveRentalFiles xmlns="http://services.advantez.com/webkits/rental/v1.4">
      <advantezKey>string</advantezKey>
      <webServiceKey>string</webServiceKey>
      <propertyId>int</propertyId>
    </retrieveRentalFiles>
  </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>
    <retrieveRentalFilesResponse xmlns="http://services.advantez.com/webkits/rental/v1.4">
      <retrieveRentalFilesResult>
        <file>
          <url>string</url>
          <description>string</description>
          <type>image or pdf or msword or msexcel or text or virtual-tour or floor-plan or epc-chart</type>
        </file>
        <file>
          <url>string</url>
          <description>string</description>
          <type>image or pdf or msword or msexcel or text or virtual-tour or floor-plan or epc-chart</type>
        </file>
      </retrieveRentalFilesResult>
      <result>successful or invalid-proptrack-key or unauthorised-domain or invalid-webservice-key or unexpected-exception or non-secure-protocol or option-not-support or insufficient-permission or invalid-parameter or invalid-advantez-key or rental-unavailable-for-dates or rental-unavailable-for-term</result>
    </retrieveRentalFilesResponse>
  </soap12:Body>
</soap12:Envelope>