PRODUCTION
This service will return the details of one property
| Resource information |
|
| Authentication |
Required |
| HTTP Method |
GET |
| Response |
JSON |
| Version |
1 |
Resource URL
<https://www.mapapropapp.com/api/action/express-v1/properties/{propertyHash}>
Sample code
GET /api/action/express-v1/properties/YoJEWd1x4qvlpGw HTTP/1.1
Host: www.mapapropapp.com
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer ya29.1.AADtN_UxybTdjLw9jX6lg_branSjjsldiwjtek4q2WvfETzSrz7Q6loEYoJEWd1x4qvlpGw
Parameters
| Key |
Type |
Required |
Description |
| propertyHash |
string |
yes |
The Hash ID of the property |
Response
A JSON document with the list of zones in a hierarchy where the customer has properties.
| Object |
Field |
Type |
Required |
Description |
| Response |
property |
Property object |
yes |
The property object |
| Property |
propertyHash |
string |
yes |
The property`s unique ID |
|
timestamp |
string |
yes |
ISO8601 timestamp of when the property was created |
|
lastUpdate |
string |
yes |
ISO8601 timestamp of when the property was last updated |
|
code |
string |
yes |
A unique code of the property entered by the customer |
|
branchId |
int |
yes |
The ID of the branch that this property is related to. Untitled (https://pucaralabs.notion.site/304293a0174549c1957484207fc0d392). |
|
type |
int |
yes |
The type of property. Untitled (https://pucaralabs.notion.site/f3cd33b259734184835577f27669aad7) |
|
propertyType |
string |
yes |
The translated description of the property type. Untitled (https://pucaralabs.notion.site/f3cd33b259734184835577f27669aad7) |
|
operation |
int |
yes |
The Id of property’s operation. Untitled (https://pucaralabs.notion.site/de093b4d74f543adb2af34a797c49bf2) |
|
propertyOperation |
string |
yes |
The translated description of the property operations. Untitled (https://pucaralabs.notion.site/de093b4d74f543adb2af34a797c49bf2) |
|
status |
id |
yes |
The Id of property’s building status. Untitled (https://pucaralabs.notion.site/de093b4d74f543adb2af34a797c49bf2) |
|
mainImage |
string |
no |
The url of the main thumbnail related to the property |
|
currency |
string |
yes |
The currency symbol of the price of the property. Untitled (https://pucaralabs.notion.site/de093b4d74f543adb2af34a797c49bf2) |
|
price |
int |
yes |
The price of the property |
|
expensesCurrencies |
string |
no |
The currency symbol of the monthly / yearly expenses of the property. Untitled (https://pucaralabs.notion.site/de093b4d74f543adb2af34a797c49bf2) |
|
expensesPrice |
int |
no |
The price of the monthly / yearly expenses of the property |
|
taxCurrency |
string |
no |
The currency symbol of the monthly / yearly taxes of the property. Untitled (https://pucaralabs.notion.site/de093b4d74f543adb2af34a797c49bf2) |
|
taxPrice |
int |
no |
The price of the monthly / yearly taxes of the property |
|
title |
string |
yes |
A title entered by the customer |
|
address |
string |
yes |
The street address and number of the property |
|
zipCode |
string |
yes |
The postal code of property location |
|
zone |
string |
yes |
A friendly description combining from city (if available) to state |
|
countryId |
int |
yes |
The ID of the property country location |
|
stateId |
int |
yes |
The ID of the property state location. Untitled (https://pucaralabs.notion.site/3b870f3e828d4073af78190661a852b6) |
|
countyId |
int |
yes |
The ID of the property county location. Untitled (https://pucaralabs.notion.site/3b870f3e828d4073af78190661a852b6) |
|
cityId |
int |
no |
The ID of the property city location. Untitled (https://pucaralabs.notion.site/3b870f3e828d4073af78190661a852b6) |
|
countryId |
int |
yes |
The ID of the property country location. Untitled (https://pucaralabs.notion.site/3b870f3e828d4073af78190661a852b6) |
|
country |
string |
yes |
The name of the country |
|
state |
string |
yes |
The name of the state |
|
county |
string |
yes |
The name of the county or 2nd division location |
|
city |
string |
no |
The name of the city / neighborhood or 3rd division |
|
suspended |
boolean |
yes |
The publication has been suspended |
|
reserved |
boolean |
yes |
The property has been reserved |
|
rented |
boolean |
yes |
The property has been rented |
|
sold |
boolean |
yes |
The property has been sold |
|
description |
string |
yes |
The long description in the property |
|
conditions |
string |
no |
The long conditions statement in the property. Usually related to payments |
|
bedrooms |
int |
no |
Number of bedrooms in the property |
|
ambiences |
int |
no |
The number of ambiences / spaces of the property |
|
bathrooms |
int |
no |
Number of bathrooms in the property |
|
dependencies |
int |
no |
Number of dependency rooms (extra rooms) |
|
occupancy |
int |
no |
Number of occupants (generally if this is a temp rental) |
|
toilettes |
int |
no |
Number of toilettes (half bathrooms) in the property |
|
buildingArea |
int |
no |
Square meters of the built area |
|
landArea |
int |
no |
Square meters of the land of the property |
|
yearsOld |
int |
no |
How old the property is |
|
ubication |
string |
no |
The property cardinal ubication in the building |
|
totalFloors |
int |
no |
The total floors in the building |
|
apartmentsPerFloor |
int |
no |
The amount of apartments per floor |
|
airConditionerType |
string |
no |
Type of air conditioner. |
|
waterHeaterType |
string |
no |
Type of water heater. |
|
heatingType |
string |
no |
Type of heating appliances. |
|
balconyType |
string |
no |
Type of balcony. |
|
garage |
int |
no |
The total garages of the property |
|
garageType |
string |
no |
Type of garage. |
|
images |
Array of Image |
no |
Array of Image object |
|
location |
Location |
yes |
Location object |
| Location |
lon |
string |
yes |
Longitude location of the property |
|
lat |
string |
yes |
Latitude location of the property |
| Image |
image |
string |
yes |
URL for image |
|
thumbnail |
string |
yes |
URL for the thumbail |
|
orientation |
int |
yes |
Orientation of the image. 1 = PORTRAIT, 2 = LANDSCAPE |
|
type |
int |
yes |
Type of image. 1 = PHOTO, 2 = BLUEPRINT |
|
contentType |
string |
yes |
The image content type |
|
timestamp |
string |
yes |
The ISO8601 timestamp of when the image was uploaded |
| Labels |
labels |
Array of labels |
no |
Labels for property - Untitled (https://pucaralabs.notion.site/de093b4d74f543adb2af34a797c49bf2) |
Sample response
{
"code": "1-6454656",
"codeSearch": "1-6454656",
"description": "gran casa en haedo capital de ahora morona",
"alternativePrices": [],
"videos": [],
"type": 20.0,
"title": "gran casa en haedo capital de ahora morona",
"branch": {
"zip": "1416",
"zone2Description": "Cañuelas",
"branchId": 773,
"address": "Camarones 2755",
"main": true,
"zone0Description": "Argentina",
"zone3": 1074,
"zone2": 155,
"zone1": 2,
"zone0": 1,
"phone1": "4581-8985",
"zone1Description": "Buenos Aires",
"custId": 1,
"name": "Sucursal Haedo",
"zone3Description": "Máximo Paz",
"email": "[email protected]",
"customer": "Mapaprop Demo INC"
},
"customerCountry": 1.0,
"zone2Desc": "Caballito",
"customerPhone": "4581-8985",
"seoUrl": "alquiler-temporario-de-loft-en-caballito-capital-federal-1-147874",
"rented": false,
"zone": "Caballito, Capital Federal, Argentina",
"price": 54554.0,
"customerEmail": "[email protected]",
"propertyType": "Loft",
"customerId": 1.0,
"codeRaw": "6454656",
"currency": "USD",
"propertyId": 147874.0,
"timestamp": "2019-10-29T00:00:00.000-03:00",
"customerAddress": "Camarones 2755",
"branchId": 773.0,
"sold": false,
"ambiences": 5,
"images": [],
"address": "paysandu 984",
"published": true,
"zone2": 18.0,
"customerName": "Mapaprop Demo INC",
"suspended": false,
"zone1": 1.0,
"labels": [
"mortgage-ready",
"professional-available",
"furnished",
"janitor",
"grill",
"storage",
"security",
"security-box",
"swimming-pool",
"party-saloon",
"cable-included",
"telephone-line",
"daily-dinning",
"alarm",
"front-garden",
"laundry",
"patio",
"playroom",
"private-elevator",
"suite"
],
"zone0": 1.0,
"zone1Desc": "Capital Federal",
"propertyOperation": "Alquiler Temporario",
"propertyHash": "e86a6a15b7f93ae633b0b009c5c51120",
"mainImage": "noimage.gif",
"lastUpdateFormated": "29-10-2019",
"reserved": false,
"lastUpdate": "2019-10-29T14:13:54.000-03:00",
"onlyWebsite": true,
"location": {
"lon": "-58.45284939999999",
"lat": "-34.6125374"
},
"operation": 3.0,
"status": 6.0,
"zone0Desc": "Argentina",
"zipCode": "1661"
}