HomeEscape API

Service

Name	Edit Property Location
Description	Edit the location of a property
Method	PUT
URL	/properties/{property}/location
Example	/api/properties/11111111/location
Access	OWNER, MANAGER

HTTP Headers

Authorization	eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields	Type	Required	Description
property	number	yes	Property id
address	text	yes	Full address by Google
latitude	number	no	Property latitude
longitude	number	no	Property longitude
apto	text	no	Specify the property number on the street
show_map	bool	yes	If want to show the specific location on the map

Response

            
                {
                    "code": R111,
                    "message": "Success"
                }

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!"
`EC014`	`Property doesn't belong to that user`	The user logged in is not the property's owner	"Sorry, you do not have access to that property!"
`EC015`	`Location not found`	Location couldn't be found either by the address or by the coordinates	Please enter a valid location
`R000`	`Fail`	The property location wasn't updated
`R111`	`Success`	The operation was successful
`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]
`VID152`	`Invalid input for address`	Address is empty or it has only characters not allowed	"Please enter a valid address"
`VID153`	`Invalid input for show_map`	Show_map is not in [0, 1]	[Call the API again using a valid value for show_map]
`VID154`	`Invalid input for latitude`	Latitude is not a number	"Please enter a valid latitude"
`VID155`	`Invalid input for longitude`	Longitude is not a number	"Please enter a valid longitude"