Accessing the feed


Request Url’s

Search Results - https://api.dezrez.com/api/simplepropertyrole/search?APIKey=

Full Details - https://api.dezrez.com/api/simplepropertyrole/ROLEID?APIKey=


API key’s

You will need an API key to access the agent’s data. This can be acquired from the web team web@dezrez.com. Please note that before we can send a key out the web team will need confirmation from the agent themselves.

The API key will be a long string of characters and will be linked to a single agency.


Request Headers

You will need to set request headers to return the data.

Header name Value
Rezi-Api-Version 1.0
Content-Type application/json

Search Parameters

To access the feed you will be required to pass through some basic search parameters before any data will be returned. Please note that these need to be sent as a JSON string.

The following parameters are required:

Parameter name Type Example Value Description
BranchIdList Collection of integer [1] The branch ID to use in the search. If left blank it will return all branches properties.
MinimumPrice integer 0 The minimum price of the properties returned. Please note that the min price and max price need to form a valid range
MaximumPrice integer 9999999 The Maximum price of the properties returned. Please note that the min price and max price need to form a valid range
MarketingFlags Collection of string ["ApprovedForMarketingWebsite"] Must be set to pull through properties that have been approved for marketing on the website.

The following parameters are optional:

Parameter name Type Example Value Description
RoleTypes Collection of string ["Selling"] or ["Letting"] Choose to display just sales or lettings properties. Leave blank to display both
IncludeStc Boolean true or false If true will display SoldSTC properties
PropertyTypes Collection of string [“TerracedHouse”] See Appendix A
MinimumBedrooms Decimal number 0 The minimum number of bedrooms the properties that are returned can have. The min and max bedrooms must form a valid range.
MaximumBedrooms Decimal number 99 The maximum number of bedrooms the properties that are returned can have. The min and max bedrooms must form a valid range.
MinimumGardens integer 0
MaximumGardens integer 2
MinimumParking integer 0
MaximumParking integer 2
MinimumTimeOnMarket time interval 00:00:00.1234567 HH:MM:SS format. Minimum and Maximum time must form a valid range
MaximumTimeOnMarket time interval 00:00:00.1234567 HH:MM:SS format. Minimum and Maximum time must form a valid range
Tags Collection of string [“new”] Agent Defined tags to add features to specific properties like “swimming pool” or “Garage”. The full list of which can be obtained from the agent.
SortBy Integer Price: 0
BedroomCount: 1
Date: 2
Alphabetically: 3
Allows the feed to be sorted by one of the four options.
SortOrder Integer Ascending: 0
Descending: 1
Sorts the feed in the specified order.
Address String “kings road” Allows the feed to be filtered by text in any of the address fields.
LastUpdated Date "2017-03-10T11:51:21.1733229Z"
MarketingRoldIds Collection of integer [1, 2] Returns a list of the specified properties if they are included in the search. Useful for a favourites search.

Pagination Parameters

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.

Parameter name Type Example Value Description
PageSize Integer 10 Dictates the number of properties that come through on each page. Default is set to 10
PageNumber Integer 1 The current page number. Default is set to 1.

Image Manipulation

Images uploaded to Rezi can be manipulated, either by adding a width or height parameter. This allows you to retrieve smaller images to lessen the overhead of loading images, when you don't need them full sized.

For an example, see the following images;

Full size:

https://docs.dezrez.com/3/dezrezcorelive/public/106202.jpg


Width set:

https://docs.dezrez.com/3/dezrezcorelive/public/106202.jpg?width=100


Height set:

https://docs.dezrez.com/3/dezrezcorelive/public/106202.jpg?height=72

Note that setting both a width and a height will crop the image, in a possibly unexpected way.

You can also rotate images, by adding a rotation parameter. Note that resizing is done before rotating.



Website Links from Rezi

When creating website links on Rezi, such as on a mail merge, the link is required to contain the RoleID of the property. 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.

Below are some examples of valid links
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)



Examples

Below are links to an example postman file and an example html file that you can use to test requests. The HTML file contains a test API key.

Example Postman File

Example HTML File