HomeEscape API

Service

Name	Get Property Location
Description	Get the location of a property
Method	GET
URL	/properties/{property}/locations
Example	/api/properties/11111111/locations
Access	EVERYONE

HTTP Headers

Authorization	eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields	Type	Required	Description
property	number	yes	Property id

Response

            
                {
                    "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"
                }

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]