Module 'REST API'

For using methods REST API turn on the module in the section "Settings" -> "Modules management ". Also check to option "Use REST API" is available to the user. You can activate or deactivate the use of REST API for a user in the admin panel when editing a user.

Authorization.

As authorization for REST API is used "BASIC" authorization: login – email user address, password - generated user token (a unique token is generated for each user). All API methods can only be used after authorization.

If you use PHP curl, then "BASIC" authorization can be executed using CURLOPT_USERPWD:

List of listings.

You can obtain a list of listings by sending the GET request to the following URL: YOUR_SITE/api/apartments.

You can also use additional parameters by sending the GET request to the following URL YOUR_SITE/api/apartments to search and get a list of listings with any characteristics.

For a list of listings from a particular country, add to the request "?country=185", where 185 – id of the country, in this case Russia.

For obtaining a list of listings from Russia->Moscow send the GET request to the following URL: YOUR_SITE/api/apartments?country=185&region=524894&city[]=524901.

If you use the module “Location”, you can get a list of countries available on the site and their id using the GET request to the url YOUR_SITE/api/options/countryLocationList.

After the request has been completed, the system returns the reponse with Code 200. Sample Response:

You can get a list of available regions in the country and their id using a GET request to the url YOUR_SITE/api/options/regionLocationList?country_id=185. Where country_id – id of a country.

After the request has been completed, the system returns the reponse with Code 200. Sample Response:

You can get a list of available cities in the region of the country and their id using the GET request to the url YOUR_SITE/api/options/cityLocationList?country_id=185&region_id=524894. Where country_id – id of a country, region_id – id of a region.

After the request has been completed, the system returns the reponse with Code 200. Sample Response:

If you are not using the module “Location”, you can get a list of available cities and their IDs using a GET request to the url YOUR_SITE/api/options/cityList.

After the request has been completed, the system returns the reponse with Code 200. Sample Response:

You can obtain a list of listings of a certain type of transaction, add "?apType=1" to the GET request to the url YOUR_SITE/api/apartments, where 1 - transaction type code.

The list of available transaction types on the site and their IDs can be obtained by performing a GET request to the url YOUR_SITE/api/options/typeList.

After the request has been completed, the system returns the reponse with Code 200. Sample Response:

For a list of properties of a particular type of property, add "?objType = 1" to the GET request on the url YOUR_SITE/api/apartments, where 1 - property type code.

The list of the property types available on the site and their IDs can be obtained by performing a GET request to the url YOUR_SITE/api/options/objTypeList.

After the request has been completed, the system returns the reponse with Code 200. Sample Response:

For a list of listings with a given price range, add "?price_min=100&price_max=2000" to GET request on url YOUR_SITE/api/apartments, where price_min and price_max - cost from 100 to 2000 conventional units (conventional unit - default currency on the site: USD/RUB/EUR/SAR etc.).

Also you can combine the above parameters for more accurate filtering of listings.

Example of GET request, which will return the list of listings from the city of Moscow with the type of transaction "rent", with the type of property "apartment" and cost from 100 to 2000 conventional units:

After the request has been completed, the system returns the reponse with Code 200. Sample Response:

Detailed description of the fields:

"id":"Listing ID",
"type":"Transaction type",
"obj_type_id":"Property type",
"price_type":"Price type",
"loc_country":"Country id",
"loc_region":"Region id",
"loc_city":"City id",
"city_id":"City id, if module 'Location' turn off",
"is_price_poa":"Price on asking. Possible values can be '1' - yes, '0' - no",
"price":"Price",
"price_to":"Price 'Up to'. It is used for property types Rent property from somebody|Buy.Do not fill in the field for other property types",
"num_of_rooms":"Number of rooms",
"floor":"Floor",
"floor_total":"Total number of floors",
"square":"Square",
"land_square":"Land square",
"lat":"Latitude",
"lng":"Longitude",
"rating":"Rating. From 0 to 10",
"is_special_offer":"Is special offer?. Possible values can be '1' - yes, '0' - no",
"owner_active":"Owner active. Possible values can be '1' - Active, '0' - Inactive",
"active":"Active: Possible values can be '2' - Awaiting moderation, '1' - Active, '0' - Inactive",
"imagesList":{
"imgCount":"Images count",
"0":{
"file_name_path":"image path"
},
"1":{
"file_name_path":"image path"
},
"2":{
"file_name_path":"image path"
}
},
"in_currency":"Currency",
"title_en":"'Title' for lang 'en'",
"address_en":"'Address' for lang 'en'",
"description_en":"'Description' for lang 'en'",
"description_near_en":"'What is near' for lang 'en'",
"exchange_to_en":"'Exchange for' for lang 'en'",
"title_ru":"'Title' for lang 'ru'",
"address_ru":"'Address' for lang 'ru'",
"description_ru":"'Description' for lang 'ru'",
"description_near_ru":"'What is near' for lang 'ru'",
"exchange_to_ru":"'Exchange for' for lang 'ru'",
"title_de":"'Title' for lang 'de'",
"address_de":"'Address' for lang 'de'",
"description_de":"'Description' for lang 'de'",
"description_near_de":"'What is near' for lang 'de'",
"exchange_to_de":"'Exchange for' for lang 'de'",
"title_es":"'Title' for lang 'es'",
"address_es":"'Address' for lang 'es'",
"description_es":"'Description' for lang 'es'",
"description_near_es":"'What is near' for lang 'es'",
"exchange_to_es":"'Exchange for' for lang 'es'",
"title_ar":"'Title' for lang 'ar'",
"address_ar":"'Address' for lang 'ar'",
"description_ar":"'Description' for lang 'ar'",
"description_near_ar":"'What is near' for lang 'ar'",
"exchange_to_ar":"'Exchange for' for lang 'ar'"

The list of available price types on the site and their codes can be obtained by running a GET request to the url YOUR_SITE/api/options/priceTypeList.

After the request has been completed, the system returns the reponse with Code 200. Sample Response:

The list of languages available on the site and their codes can be obtained by performing a GET request to the url YOUR_SITE/api/options/langList.

After the request has been completed, the system returns the reponse with Code 200. Sample Response:

You can get a list of available currencies on the site and their codes by running a GET request to the url YOUR_SITE/api/options/currencyList.

After the request has been completed, the system returns the reponse with Code 200. Sample Response:

You can get a list of available activity statuses and their codes by running a GET request to the url YOUR_SITE/api/options/ownerStatusList.

After the request has been completed, the system returns the reponse with Code 200. Sample Response:

You can get a list of available global activity statuses and their codes by running a GET request to the url YOUR_SITE/api/options/statusList.

After the request has been completed, the system returns the reponse with Code 200. Sample Response:

Information about the listing.

Send GET request to url YOUR_SITE/api/apartments/ID_OBJECT, where ID_OBJECT - id of the object.

After the request has been completed, the system returns the reponse with Code 200. Sample Response:

Adding an listing.

Send a POST request to the url YOUR_SITE/api/apartments.
In the POST array, pass at least the following information:

• Apartment[owner_active]. Owner status (0|1). To get a list of available statuses and their names send a GET request to the url YOUR_SITE/api/ownerStatusList;
• Apartment[type]. Transaction type (1|2|3|4|5). To get a list of available id and their name send a GET request to the url YOUR_SITE/api/typeList;
• Apartment[price_type]. Price type (1|2|3|4|5|6|7|8). To get a list of available id and their name send a GET request to the url YOUR_SITE/api/priceTypeList;
• Apartment[obj_type_id]. Property type (1|2|3|4|5 etc). To get a list of available id and their name send a GET request to the url YOUR_SITE/api/objTypeList;
• Apartment[price]. Price (1000|2000|3000 и т.п.);
• Apartment[in_currency]. Currency (USD|RUB|EUR|SAR etc). Only if the multicurrency version is used. For a list of available currencies, send a GET request to the url YOUR_SITE/api/currencyList;
• 
  If the module "Location" is enabled
  Apartment[loc_country]. id of a country. To get a list of available countries and their names send a GET request to the url YOUR_SITE/api/options/countryLocationList
  Apartment[loc_region]. id of a region. To get a list of available regions of the country and their names send a GET request to the url YOUR_SITE/api/options/regionLocationList?country_id=ID_COUNTRY, where ID_COUNTRY – id of a country
  Apartment[loc_city]. id of a city. To get a list of available cities in the region and their names send a GET request to the url YOUR_SITE/api/options/cityLocationList?country_id=ID_COUNTRY®ion_id=ID_REGION, where ID_COUNTRY - id of a country and ID_REGION - id of a region
  
  If the module "Location" is disabled:
  Apartment[city_id]. id of a city. To get a list of available cities and their names send a GET request to the url YOUR_SITE/api/options/cityList
  
  
• Apartment[imagesList]. List of links to images to add them to the object;
• Apartment[title_en]|Apartment[title_ru]|Apartment[title_de]|Apartment[title_es]|Apartment[title_ar]. The title of the object in all active languages of the site. For a list of available languages send a GET request to the url YOUR_SITE/api/langList
• Apartment[description_en]|Apartment[description_ru]|Apartment[description_de]|Apartment[description_es]|Apartment[description_ar]. Description of the object in all active site languages;
• Apartment[address_en]|Apartment[address_ru]|Apartment[address_de]|Apartment[address_es]|Apartment[address_ar]. The address of the object (street, house) in all active languages of the site.

Example:

After the request has been completed, the system returns the reponse with Code 200. Sample Response:

The response will have the id value of the created object equal to 38 ("id":"38"), which, if necessary can be used for their own purposes.

Updating information about the listing.

Send a PUT request to the url YOUR_SITE/api/apartments/ID_OBJECT, where ID_OBJECT – id of editable object, for example, 56.

All transmitted fields and values are identical to the method of adding an object.

After the request has been completed, the system returns the reponse with Code 200. Sample Response:

Deleting an listing.

Send a DELETE request to the url YOUR_SITE/api/apartments/ID_OBJECT, where ID_OBJECT – id of deleted object, for example, 82.

After the request has been completed, the system returns the reponse with Code 200. Sample Response:

You can familiarize yourself with the functions of the module by sending requests to the url: https://demo-pro.open-real-estate.info instead YOUR_SITE
Login and password for HTTP authorization - adminre@monoray.net:174cc583994a138b2bb204a1e005186d

If you need any improvements of the functions of the module, then we can do it for an additional fee.
Contact us through the form "Contacts".