HomeEscape API

Service

Name	Get Property Places
Description	Get interest places near of a property
Method	GET
URL	/properties/{property}/places
Example	/api/properties/11111111/places
Access	EVERYONE

HTTP Headers

Authorization	eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields	Type	Required	Description
property	number	yes	Property id

Response

            
                {
                    "car": "2",
                    "airport": "Miami International Airport",
                    "airport_distance": 15,
                    "airport_distance_unit": 0,
                    "beach": "North City Beach Park",
                    "beach_distance": 8,
                    "beach_distance_unit": 0,
                    "ferry": "null",
                    "ferry_distance": "null",
                    "ferry_distance_unit": "null",
                    "train": "Golden Glades Station",
                    "train_distance": 2,
                    "train_distance_unit": 0,
                    "highway": "I-95 Express",
                    "highway_distance": 1,
                    "highway_distance_unit": 0,
                    "bar": "Martini Bar at Gulfstream Park",
                    "bar_distance": 7,
                    "bar_distance_unit": 0,
                    "ski": "null",
                    "ski_distance": "null",
                    "ski_distance_unit": "null",
                    "golf": "Shula's Golf Club",
                    "golf_distance": 7,
                    "golf_distance_unit": 0,
                    "restaurant": "Chili's Grill & Bar",
                    "restaurant_distance": 6,
                    "restaurant_distance_unit": 0
                }

Response Codes

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]