Live property search - Rezi website feed

A requirement of using the Rezi property search framework is that the integrated customer’s website must contain the following:

Powered by the Dezrez Rezi API

https://www.dezrez.co.uk

You will need an API key in order to request any data, you will need to talk to our mutual client for them to request one for you to use.

The Rezi Web API allows developers to populate customer’s website with real time data from the software by sending specific queries to our API endpoints, it also allows you to post customer leads to Rezi. This gives the web developer full control over what data to display on a customer’s website and how to display it.

This document provides technical information to web developers wishing to integrate a customer’s website with Rezi property data and pass customer leads back to Rezi and provides a JSON schema.

Note: The Branch ID, Agency ID & API Key is not permitted to be displayed in any URL for the website; please store this information in a configuration file as variables. Failure to comply will result in the API Key being suspended.

Returning the live JSON property data is achieved by submitting a standard HTTP request to our servers. Our servers will return the data in JSON format based on the search criteria included in the request. You can then make a separate API request for full property data for properties included in the search results when required.

It is up to you how you build your feed processor and request data from the API, the below information will help you request and process the correct data.

The two URLs which form the basis for getting property data for an customer’s website, both require the following request headers:

This URL will return the full details of an individual property.

GET https://api.dezrez.com/api/simplepropertyrole/%ROLEID%?APIKey=

There’s no parameters for this call beyond the API key and the RoleID (See Appendix B).

This URL will returns an overview of all current Sales and Lettings properties that are on the market with the customer (STC, Exchanged and Let Agreed are not returned by default).

POST https://api.dezrez.com/api/simplepropertyrole/search?APIKey=

As well as the headers you will need to include a JSON string that contains the following information as a minimum.

The feed will paginate the data with the defaults of 10 properties per page and will return page 1. To change these you will need to pass through the following parameters.

Below is a link to a postman collection with a test API key so you can see how the data is returned from our API.

Sometimes, Customer’s don’t want their STC or Under Offer properties to be advertised as such. You need to look at the "Flags" array, as well as the "RoleStatus" object to establish how a property should be marketed. 

The flags to be tested for have a SystemName of "UnderOffer" or "OfferAccepted". This may vary based on client needs.

Images are returned in the JSON collection as URLs, the URL will return a full-sized image, but it is advisable to add a width or height parameter in order to optimise your images for web pages.

Note that you can either set a width or a height, not both.

Additionally, you can set the quality of the images by adding the "quality" parameter. This accepts a value between 1 and 100, with 100 being best quality and 1 being worst quality. 

Images will usually come through in the feed with a versioning string, for example:

You will need to query the URL for the presence of this string before deciding whether to add “?&width” or just “&width”, so if there is a string your request would look like this:

It is not uncommon for Customer’s to want to send some correspondence from Rezi that automatically generates links to properties on their website. Rezi can do this if the website has the property RoleID (see appendix B) in the URL structure.

This link is not required to be the main link to properties in the case of SEO purposes, and can just redirect to the necessary page.

www.example.com/details.html?roleid={RoleId}

www.example.com/properties/{RoleId}

www.example.com/anythingcangohere/{RoleId}

www.example.com/propertiesviaid/{RoleId} which redirects to www.example.com/properties/{otherid}

www.example.com/properties/-/-/{RoleId} (where the hyphens are usually specific to the property)

The Rezi web feed returns property data in a JSON format, when requesting the full details for a property please use the RoleID and not the propertyID (see appendix B).

Please Note not all of the properties that appear in the feed are meant to appear on the customer’s website. As the feed can be used for multiple purposes you will need to filter by the flag “ApprovedForMarketingWebsite”. You can do this by using the "MarketingFlags" parameter, and setting it to ["ApprovedForMarketingWebsite"].

For the majority of the information in the feed there will be multiple nodes for each. Most will contain a system name and a display name. The System name is used for filtering by while the Display name is used for populating the website.

The Full Details Response will include all the collection data listed above with the following additions.

The Inbound Leads end points allows you to send customer enquiries to a Rezi endpoint via a HTTP POST with a JSON body so that they are made available to the customer within the Rezi Software – e.g. Viewing Requests, Valuation Request. The leads are processed by our endpoint in real time so information submitted through your website should be available in Rezi almost straight away.

POST https://api.dezrez.com/api/inboundlead/create?BranchId=&APIKey=

     Important: You must supply the relevant BranchId for this request as a query parameter. If you do not know        your Branch ID's, please contact our Support Team who will be able to advise.

The following headers will need to be set to successfully send data:

Below is a link to a postman collection with a test API key so you can see how the data is returned from our API.

You will notice while working with the Rezi API that Rezi has two IDs assigned to properties in the data collection; a PropertyID and a RoleID and for the purposes of marketing properties from Rezi the RoleID is more important that the PropertyID.

A property in Rezi is partly defined by it’s address and when a property’s details are added to Rezi it is assigned a PropertyID. This PropertyID is unique and in theory there will not be another PropertyID with that address within that Customer’s Rezi data.

So how does Rezi handle multiple marketing cycles where a property is sold and sold again by the same customer or Let and Let again?

Well, that’s where RoleIDs come in to play. When a property is instructed it gets a RoleID, this unique ID represents a marketing cycle and is a child of the PropertyID. So one PropertyID can have multiple RoleIDs representing multiple marketing cycles. Some might be historic, but there are situations where a property might have multiple active marketing cycles – for example if it is being advertised for sale and for let.

Because there are instances where a collection might include a PropertyID twice – once for Sales and once for Lettings we strongly advise always using the RoleID to identify the properties you are working with and not the PropertyID.

We cannot guarantee the quality of the coordinates stored against a property. The information is initially obtained from the post office based on the postcode entered by the customer. The customer then has the ability to adjust the location and street-view within Rezi.