| Name | Get Property |
|---|---|
| Description | Get information of a property |
| Method | GET |
| URL | /properties/{property} |
| Example | /api/properties/11111111 | Access | OWNER, MANAGER, TRAVELER, PARTNER |
| Authorization | eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9... |
|---|---|
| Fields | Type | Required | Description |
|---|---|---|---|
| property | number | yes | Property id |
{
"id": "43749420",
"name": "Home Test API",
"tagline": "The Best Home",
"description": "Here is an example Here is other example Here is other example",
"luxury": false,
"size": "400",
"size_unit": 0,
"property_type": "Townhome",
"location_types": [
"Near The Ocean",
"Waterfront",
"Golf"
],
"bedrooms": 3,
"bathrooms": 2,
"half_bath": 2,
"sleeps": 8,
"currency": "USD",
"bedding": "Here is other example",
"reviews_av": 5,
"reviews_total": 1,
"featured": false,
"subscribed": false,
"purchased": "2008",
"why_this": "null",
"benefits": "null",
"share": "http://dev.homeescape.com/vacation-rental/55853851",
"location": {
"address": "1450 S Miami Ave, Miami, Florida 33130, United States",
"latitude": "25.759416000000",
"longitude": "-80.194138000000",
"country": "USA",
"state": "Florida",
"city": "Miami",
"neighborhood": "Brickell",
"postal_code": "33130",
"show_map": "false"
},
"images": [
{
"id": 000001,
"description": "Picture 1",
"image": "http://dev.homeescape.com/uploads/images/6036/55853851/medium/HE-55853851-0000001.jpg"
},
{
"id": 000002,
"description": "Picture 2",
"image": "https://dev.homeescape.com/uploads/images/6036/55853851/medium/HE-55853851-0000002.jpg"
},
{
"id": 000003,
"description": "Picture 3",
"image": "https://dev.homeescape.com/uploads/images/6036/55853851/medium/HE-55853851-0000003.jpg"
},
...
],
"places": {
"car": "2",
"airport": "Miami International Airport",
"airport_distance": 5,
"airport_distance_unit": 2,
"beach": "Miami Beach",
"beach_distance": 2,
"beach_distance_unit": 2,
"ferry": "Bahamas Ferry",
"ferry_distance": 10,
"ferry_distance_unit": 2,
"train": "Golden Glades Station",
"train_distance": 2,
"train_distance_unit": 2,
"highway": "Palmetto",
"highway_distance": 3,
"highway_distance_unit": 2,
"bar": "Martini",
"bar_distance": 10,
"bar_distance_unit": 2,
"ski": "Ski Zone",
"ski_distance": 20,
"ski_distance_unit": 2,
"golf": "Super Golf Club",
"golf_distance": 5,
"golf_distance_unit": 2,
"restaurant": "Versalles Dos",
"restaurant_distance": 10,
"restaurant_distance_unit": 2
},
"amenities": {
"children": true,
"children_desc": "It is a long established fact that a reader will be distracted ...",
"smoking": true,
"smoking_desc": "sample",
"pets": "null",
"pets_desc": "sample",
"wheelchair_accessible": true,
"wheelchair_accessible_desc": "sample",
"long_termrenters": true,
"long_termrenters_desc": "sample",
"minimum_age_rent": true,
"minimum_age_rent_desc": "sample",
"events_allowed": true,
"events_allowed_desc": "Events isn't allowed",
"airconditioned": true,
"airconditioned_desc": "sample",
"excercise_room": true,
"excercise_room_desc": "sample",
"fireplace": true,
"fireplace_desc": "sample",
"garage": false,
"garage_desc": "sample",
"heater": true,
"heater_desc": "sample",
"private_pool": true,
"private_pool_desc": "sample",
"telephone": true,
"telephone_desc": "sample",
"hot_tub": true,
"hot_tub_desc": "sample",
"washing_machine": true,
"washing_machine_desc": "sample",
"parking": true,
"parking_desc": "sample",
"linens": true,
"linens_desc": "sample",
"towels": true,
"towels_desc": true,
"yard": true,
"yard_desc": "sample",
"deck": true,
"deck_desc": "sample",
"wood_stove": true,
"wood_stove_desc": true,
"clothes_dryer": true,
"clothes_dryer_desc": "sample",
"livingroom": true,
"livingroom_desc": "sample",
"senior_community": true,
"senior_community_desc": "sample",
"balcony": true,
"balcony_desc": "sample",
"hairdryer": true,
"ironboard": true
},
"entertaiments": {
"television": true,
"television_desc": "description",
"cable": true,
"cable_desc": "description",
"stereo": true,
"stereo_desc": "description",
"music_library": true,
"music_library_desc": "description",
"premiun_channels": true,
"premiun_channels_desc": "description",
"internet_access": true,
"internet_access_desc": "description",
"wireless_internet_access": true,
"wireless_internet_access_desc": "description",
"video_games": true,
"video_games_desc": "description",
"video_library": true,
"video_library_desc": "description",
"toys": true,
"toys_desc": "description",
"board_games": true,
"board_games_desc": "description",
"books": true,
"books_desc": "description",
"pooltable": true,
"pooltable_desc": "description",
"communal_pool": true,
"communal_pool_desc": "description",
"sauna": true,
"sauna_desc": "description",
"indoor_pool": true,
"indoor_pool_desc": "description",
"heated_pool": true,
"heated_pool_desc": "description"
},
"kitchen": {
"kitchen": true,
"kitchen_desc": "description",
"kitchen_utensils": true,
"kitchen_utensils_desc": "description",
"refrigerator": true,
"refrigerator_desc": "description",
"blender": true,
"blender_desc": "description",
"freezer": true,
"freezer_desc": "description",
"microwave": true,
"microwave_desc": "description",
"dishwasher": true,
"dishwasher_desc": "description",
"toaster": true,
"toaster_desc": "description",
"coffe_maker": true,
"coffe_maker_desc": "description",
"stove": true,
"stove_desc": "description",
"oven": true,
"oven_desc": "description",
"garbage_disposal": true,
"garbage_disposal_desc": "description",
"grill": true,
"grill_desc": "description"
},
"attractions": {
"bar_nightclub": true,
"beach": true,
"casino": true,
"charterboats": true,
"deep_seat_fishing": true,
"airports": true,
"horsebackriding": true,
"shoopping": true,
"snorkeling": true,
"car": true,
"car_desc": "description",
"chauffeur": true,
"chauffeur_desc": "description",
"concierge": true,
"concierge_desc": "description",
"private_chef": true,
"private_chef_desc": "description",
"staff": true,
"staff_desc": "description",
"massage": true,
"massage_desc": "description"
}
"medialinks": [
{
"id": 00001,
"link": "https://youtu.be/i-kO1jKE3DM",
"description": "Video of Youtube",
"type": "video"
},
{
"id": 00002,
"link": "https://www.telxcomputers.com/",
"description": "Telx Computers is Miami's leading IT Support Company",
"type": "web"
},
{
"id": 00003,
"link": "https://www.telxweb.com/",
"description": "Telx Web is the Miami Marketing Agency with over 10 years of experience",
"type": "web"
},
{
"id": 00004,
"link": "https://www.homeescape.com/",
"description": "We can now process online booking",
"type": "web"
}
],
}
| Code | Message | Cause | Possible Frontend Message [Behavior] |
|---|---|---|---|
EC000 |
Internal error in API |
Internal error connecting the database | "Oops! Looks like we hit a snag. Try closing the app and reopening it." |
EC001 |
User not found |
Token user id doesn't match our records | "Sorry, We couldn't find your information!" |
EC002 |
Property not found |
Property id doesn't match our records | "Sorry, We couldn't find that property!" |
SC006 |
User no authorization |
The token role is not valid for using the API services | "You have been logged out." - [Take the user to the login screen] |
SC014 |
Expired token |
The token has expired | "You have been logged out." - [Take the user to the login screen] |
VID112 |
Invalid input for property |
Property id is not a number | [Call the API again using a valid value for property id] |