HomeEscape API

Service

Name	Get Property Image
Description	Get an image of a property
Method	GET
URL	/properties/{property}/images/{image}
Example	/api/properties/11111111/images/194691
Access	EVERYONE

HTTP Headers

Authorization	eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields	Type	Required	Description
property	number	yes	Property id
image	number	yes	Image id

Response

            
                {
                    "id": 194691,
                    "description": "Front",
                    "image": "https://www.homeescape.com/uploads/images/9283/55853851/medium/HE-55853851-3768490.jpg"
                }

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!"
`EC012`	`Image not found`	Image id doesn't match our records	[Show the default picture for properties]
`EC027`	`Image does not belong to the property`	Image id does not belong to the property	[Show the default picture for properties]
`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]
`VID162`	`Invalid input for image`	Image id is not a number	[Call the API again using a valid value for image id]
`VID275`	`Invalid input for size`	Size is not in [thumbnail, medium, large]	[Call the API again using a valid value for the size]