Arrange Appraisals

Description: Allows developers to build their own Appraisal engine like the one on Zoopla by making three separate API calls to find a property and contact the agent for a valuation.

For testing purposes, we have blacklisted zoopla_developer@mashery.com

Input parameters (step 1)

1st Access URI: http://api.zoopla.co.uk/api/v1/postcode_properties

The 1st method uses the input parameter to detail which properties are within the postcode sector of interest.

Key nameDescription
postcode The name of the post town that the property is located within.

Generated output

Key nameDescription
property_id The Zoopla unique property identifier for this property.
full_address The full address of the property, including door numbers.
result_count Total number of results in this data set.

 

Input parameters (step 2)

2nd Access URI: http://api.zoopla.co.uk/api/v1/property_appraisal_branches

The 2nd method uses the property_id parameter to detail which Agents are within reasonable distance to provide an appraisal for the property.

Key nameDescription
property_id The Zoopla unique property identifier for this property. Taken from 1st call

Generated output

Key nameDescription
property_id The Zoopla unique property identifier for this property.
full_address Each listing in the result set is contained with an agent element with the following key/value pairs:
branch_id The Zoopla unique branch identifier for this property agent.
company_id The Zoopla unique company identifier for this property agent.
name The name of this branch.
address The address of the branch.
logo A fully qualified URL for an image for this branch's logo, or an empty string if there isn't one associated.
featured Outputs Yes or No indicating whether the agent must be pre-included for contact above the non-featured agents for appraisal services.  

result_count Total number of results in this data set.

 

Input parameters (step 3)

3rd Access URI: http://api.zoopla.co.uk/api/v1/arrange_appraisal

The 3rd method requires the below parameters to be passed for a successful appraisal request to an Agent.

Key nameDescription
branch_id A specific branch_id to request the appraisal service(s) from. Taken from 2nd call.
property_id The Zoopla unique property identifier for this property. Taken from 1st call.
name Name of the customer.
email E-mail address which the agent can contact the customer on.
phone Phone number on which the agent can contact the customer.
phone_type The type of phone number provided, defaults to "mobile":
  • mobile
  • work
  • home
best_time_to_call The best time for the agent to call the phone number provided, defaults to "anytime":
  • anytime
  • afternoon
  • evening
  • morning
message (optional) A free-form message to be sent to the agent along with the other details, defaults to a blank message.
type_of_enquiry The nature of the appraisal enquiry can be one of the following
  • arrange_valuation
  • looking_to_sell
  • looking_to_let
session_id (optional) A session identifier provided by the get_session_id API method call, although this is optional.

Generated output

The following output parameters are generated.

Key nameDescription
success Either "1" or "0" to indicate whether the request was successful. If a value of "0" is returned there will also be an "error" parameter generated.
error The error which cause the request to be unsuccessful, which can be one of the following values:
  • invalid_email - the e-mail address that was provided was invalid.
  • error code - insufficient or unrecognised input parameters.