Panel/Fee Lookup Web Service

Some of our clients have asked for us to provide a Panel/Fee Lookup Web Service (abbreviated P/FLWS).

We've implemented a (non SOAP) working draft. It will allow you to post in the following fields and get back the valfirms and fees for that suburb. This is a Web Service implementation of our existing Fee Lookup tool within ValEx, which is available under Order Valuation -> Fee Lookup.

We now accept Land Area information of the property to decide whether the Rural Residential Fees applies or not. One extra parameter has been added to the Fee-Lookup webservice, which is non-mandatory.

URL

https://ws.valex.com.au/rest/fee-lookup/

Parameters

  • username - Your Valex username (HTTP POST only) (string)
  • password - Your Valex password (HTTP POST only) (string)
  • postcode - A valid Australian postcode (int)
  • suburb_name - A valid Australian suburb name (string)
  • serv_id - A Valex Service ID (int)
  • estimate - Owners Estimated Value (int)
  • funder_id - A Funder identifier in ValEx (optional) (int)
  • land_area - Land area (SQM) (optional - useful for determining if a Rural Residential Fee should apply)

Service Identifiers

  • 5 - Kerbside Assessment
  • 9 - Residential Long Form
  • 10 - Residential ShortForm

Funder Identifiers

Clients with a relationship to a known Funder in ValEx can request a list of Funder names and Identifiers from us.

How does it work?

Request

Simply submit a request, building up a URL like below:

https://ws.valex.com.au/rest/fee-lookup/?postcode=5000&suburb_name=Adelaide&serv_id=10&estimate=30000

Make sure you provide your username / password over HTTP POST, to ensure these are kept secure.

Response

You'll get back some XML, like below.

<panel>
    <!-- See http://developers.valex.com.au/ for documentation -->
    <valfirms>
        <valfirm id="VXV-4" name="Megaw &amp; Hogg - Melbourne" />
        <valfirm id="VXV-298" name="Preston Rowe Paterson Melbourne" />
    </valfirms>
    <fees>
        <fee amount="175.00" description="Valuation Fee" name="ValuationFee" />
    </fees>
</panel>

Errors

For any errors, you'll simply get an error node with a string, and a HTTP 505 response code:

<error>Suburb not found, is it in the Australia post database?</error>

An Example Client (PHP)

Source

Example Client (Java)

Source

Example Client (Objective-C, iPhone)

Source

More Reading

AttachmentSize
example_fee_response.xml368 bytes
fee-lookup-schema.xsd1.21 KB
example_fee_error.xml70 bytes