How to Integrate Masterkey with Property Portals (v2)
Introduction
This article will help Portal Partners integrate with Masterkey's portal webservice. It includes a description of the parameters and schemas, as well as examples with sample data for you to connect your website.
Other Integrations
- If you are an Agency / Broker and want to integrate your website then please follow this guide on Company website
- If you are an existing Portal Partner and ready for two way integration then please follow instructions on PostNow
Sample XML
Use the webservice to extract sample data so you can test the connection.
- Step 1: Open http://webservice.gomasterkey.com/v1.1/portal.asmx
- Step 2: Select method RentListings
- Step 3: Enter your AccessCode obtained from Masterkey Support
- Step 4: Enter groupcode 1015 for Masterkey Test Group
- Step 5; Click the button [Invoke] to request listing data in browser
Overview of methods
While SalesListing and RentalListing are the main methods to use, you also will find a number of other methods on the webservice.
Method |
Definition |
Dubizzle |
Official schema defined by classified fields website Dubizzle |
Generic |
Outdated generic feed used by few portal partners |
GetGroupWebPortals |
List of groups and their contact details, listings count |
RentListings |
Full feed of all Rental listings |
RentListingsLastUpdated |
Incremental feed of Rental listings updated int he last 24 hours |
SalesListings |
Full feed of all Sales listings |
SalesListingsLastUpdated |
Incremental feed of Sales listings updated int he last 24 hours |
SalesListing Request
Parameter Name |
Data Type |
Is Required |
AccessCode |
String |
Yes |
GroupCode |
Integer |
Yes |
Bedrooms |
Integer |
No |
StartPriceRange |
Integer |
No |
EndPriceRange |
Integer |
No |
Category_Id |
Integer |
No |
State_Pk |
String |
No |
Community_Pk |
String |
No |
Unit_Pk |
Integer |
No |
Property_Pk |
String |
No |
SalesListing Response
Field Name |
Data Type |
Length |
Definition |
Count |
Integer |
Number of Units in the XML feed |
|
Unit_Builtup_Area |
Decimal |
12,2 |
Total covered area of the apartment or commercial property Unit |
City |
String |
400 |
City name, level 2 |
Community |
String |
Community name, level 3 |
|
Sub_Community |
String |
400 |
Sub-Community name, level 4 |
District |
String |
400 |
City name |
State |
String |
State name |
|
Listing Agent |
String |
Name of the real estate agent |
|
Listing Agent Phone |
Integer |
Phone number of the real estate agent |
|
Listing Agent Email |
String |
Email of the real estate agent |
|
No Of Bathrooms |
Integer |
Number of bathrooms in the unit |
|
Primary View |
String |
Main view of the Unit (Eg: Fountain view, Community view, Sea view etc) |
|
Property Name |
String |
200 |
Name of building (Eg: Burj Khalifa, Empire State Building, ) |
Selling Price |
Decimal |
12,3 |
Selling Price of the Unit (Eg: 1300000.000) |
Marketing Title |
String |
Marketing title of the Unit (this will be the unit title) |
|
Web Remarks |
String |
Marketing description |
|
Unit Type |
String |
Unit type (Eg: Apartment, Villa). List of types are mentioned below |
|
Bedroom Details |
Integer |
400 |
Number of bedrooms in the unit |
Images |
Group |
Image urls and the image title |
|
Unit PK |
Integer |
Unique reference number of the Unit |
|
Unit Reference No |
Integer |
30 |
Both internal and external reference number of the Unit |
Last Updated |
Integer |
Returns the no of Bedrooms of the Unit |
|
Floor Number |
Integer |
400 |
Returns the floor no of the Unit |
Arabic Description |
String |
Returns the Arabic Description of the Unit (this will be the unit description in Arabic) |
|
Arabic Title |
String |
Returns the Arabic title of the Unit (this will be the unit title in Arabic) |
|
Floor Plan |
Integer |
Returns the Floor Plan of the Unit (Image URL) |
|
Site Info and Amenities Desc |
String |
||
No of Rooms |
Integer |
Returns the rooms of the Unit (used for labour camps) |
|
Unit Model |
Integer |
Returns the Unit Model (Eg: 3M) |
|
Audio Tour |
String |
||
Facilities |
Group |
||
Branch Name |
String |
200 |
Branch Name |
Branch Phone |
Integer |
Branch Phone |
|
Rent Per Annum |
Integer |
Rent price of the Unit (you can leave it blank for Sales) |
|
Unit Measure |
String |
Returns the measure of the Unit (Eg: Sq. Ft, Sq. Mts) |
|
Company ID |
Integer |
||
Company Email |
String |
Email address of Company |
|
Company Phone |
Integer |
Phone number of Company |
|
Company Name |
String |
Name of Company |
|
Company Logo |
String |
URL link image to Company logo |
|
GroupWebURL |
String |
URL link to Company Website |
|
Company Registration Number |
Integer |
For example RERA Office Registration Number |
|
Freehold |
Leasehold / Freehold |
||
permit_number |
Thrakesihi |
||
USP |
Granddaddy of marketing title and description |
||
Site_Info_and_Amenities_Desc |
Area description (Short) from property file |
||
Map_Coordinates |
Long Lat |
||
Maintenance_Fee |
Service charge developer charges |
||
Unit_Plot_Area |
Boundary wall vs constructed area |
||
Secondary_View |
|||
Sub_Type |
Always classified belong to Unit type - Bungalo |
||
Local_Area_and_Amenities_Desc |
Higher level - Area description (Short) from property file |
||
Marketing_Phone |
???? |
||
Listing_Date |
The first time a listing was published |
||
ExternalImages |
External URL image |
||
HandOver_Date |
Handed over from the developer |
||
GroupWebUrl |
??? |
SalesListingsLastUpdated
The SalesListingsLastUpdated method will return data of all Units where changes have occurred in the Last 24 hours. This can be used to:
- Remove Listings that have sold in the last 24 hours
- Update listings that have changed in the last 24 hours
RentListing Method
The RentListing web method returns the complete Unit details for Lease / Rental Units (eg: City, Community, Rent Per Annum, Images etc)
Parameter Name |
Data Type |
Is Required |
AccessCode |
String |
Yes |
GroupCode |
Integer |
Yes |
Unit_pk |
Integer |
No |
PropertyType |
String |
No |
Bedrooms |
Integer |
No |
State_pk |
String |
No |
Community_pk |
String |
No |
StartPriceRange |
Integer |
No |
EndPriceRange |
Integer |
No |
RentListing Response
Field Name |
Data Type |
Length |
Definition |
Count |
Integer |
Returns the count of Units |
|
Unit Builtup Area |
Decimal |
12,2 |
Returns the Built Up area of the Unit |
City |
String |
400 |
Returns the value of the City name |
Community |
String |
400 |
Returns the value of the Community name |
Listing Agent |
String |
Returns the name of the Listing Agent |
|
Listing Agent Phone |
Integer |
Returns the phone number of the Listing Agent |
|
District |
String |
400 |
Returns the value of the City name |
No Of Bathrooms |
Integer |
Returns the no of Bathrooms of the Unit |
|
Primary View |
String |
Returns the main view of the Unit (Eg: Fountain View) |
|
Property Name |
String |
200 |
Returns the value of the Property name (Eg: Burj Khalifa) |
Selling Price |
Decimal |
12,3 |
Returns the Selling Price of the Unit (Eg: 1300000.000) |
State |
String |
Returns the value of the State name |
|
Web Remarks |
String |
Returns the remarks of the Unit (will be used as Unit Description) |
|
Listing Agent Email |
String |
Returns the Listing Agent Email |
|
Unit Type |
String |
Returns the type of the Unit (Eg: Apartment, Villa). List of types are mentioned below |
|
Bedroom Details |
Integer |
400 |
Returns the no of Bedrooms of the Unit |
Images |
Returns the image url of the Unit and the image title |
||
Unit PK |
Integer |
Returns the unique reference no of the Unit |
|
Last Updated |
Integer |
Returns the no of Bedrooms of the Unit |
|
Unit Reference No |
Integer |
30 |
Returns the unique reference no of the Unit |
Floor Number |
Integer |
400 |
Returns the floor no of the Unit |
Marketing Title |
String |
Returns the Marketing title of the Unit (this will be the unit title) |
|
Arabic Description |
String |
||
Arabic Title |
String |
||
Floor Plan |
Integer |
Returns the Floor Plan of the Unit (Image URL) |
|
Site Info and Amenities Desc |
String |
||
No of Rooms |
Integer |
||
Unit Model |
Integer |
||
Audio Tour |
|||
Sub Community |
String |
400 |
Returns the value of the Sub-Community name |
Branch Name |
String |
200 |
Returns the Branch Name |
Branch Phone |
Integer |
||
Rent Per Annum |
Integer |
Returns the Rent of the Unit (you can leave it blank for Sales) |
|
Unit Measure |
String |
Returns the measure of the Unit (Eg: Sq. Ft, Sq. Mts) |
|
Company ID |
Integer |
||
Company Email |
String |
||
Company Phone |
Integer |
Returns the Company Phone No |
|
Company Name |
String |
Returns the Company Name |
|
Company Logo |
String |
Returns the Company Logo (Image URL) |
|
GroupWebURL |
String |
Returns the Company Website URL |
|
Company Registration Number |
Integer |
RentListingsLastUpdated
The RentListingsLastUpdated method will return data of all Units where changes have occurred in the Last 24 hours. This can be used to:
- Remove Listings that have leased in the last 24 hours
- Update listings that have changed in the last 24 hours
Unit Status
When a Unit changes to Reserved, Sold or Leased the Unit will be marked as DELETED inside the LastUpdated methods.
Full feed of all Rental listings |
Phone number of Company |
Comments
0 comments
Please sign in to leave a comment.