HomeEscape API

Service

Name	Edit Property Amenities
Description	Edit the home's amenities of a property
Method	PUT
URL	/properties/{property}/amenities
Example	/api/properties/11111111/amenities
Access	OWNER, MANAGER

HTTP Headers

Authorization	eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields	Type	Required	Description
property	number	yes	Property id
children	bool	no	If allowed children.
children_desc	text	no	Description about allowed children, only fill when children is allowed.
smoking	bool	no	If allowed smoking.
smoking_desc	text	no	Description about allowed smoking, only fill when smoking is allowed.
pets	bool	no	If allowed pets.
pets_desc	text	no	Description about allowed pets, only fill when pets is allowed.
wheelchair_accessible	bool	no	Is property has accessible for wheelchair.
wheelchair_accessible_desc	text	no	Description about accessible for wheelchair, only fill when wheelchair_accessible is allowed.
long_termrenters	bool	no	Is property allowed rent for long terms.
long_termrenters_desc	text	no	Description about allowed rent for long terms, only fill when long_termrenters is allowed.
minimum_age_rent	bool	no	If exist a minimum age for rent.
minimum_age_rent_desc	text	no	Description about minimum age required for rent, only fill when minimum_age_rent is true.
events_allowed	bool	no	If allowed events.
events_allowed_desc	text	no	Description about allowed events, only fill when event is allowed.
airconditioned	bool	no	If property has airconditioned.
airconditioned_desc	text	no	Description about airconditioned, only fill when airconditioned is true.
excercise_room	bool	no	If property has exercise room.
excercise_room_desc	text	no	Description about exercise room, only fill when excercise_room is true.
fireplace	bool	no	If property has fire place.
fireplace_desc	text	no	Description about fire place, only fill when fireplace is true.
garage	bool	no	If property has garage for traveler.
garage_desc	text	no	Description about garage, only fill when garage is true.
heater	bool	no	If property has heater.
heater_desc	text	no	Description about heater, only fill when heater is true.
private_pool	bool	no	If property has private pool.
private_pool_desc	text	no	Description about private pool, only fill when private_pool is true.
telephone	bool	no	If property has telephone.
telephone_desc	text	no	Description about telephone, only fill when telephone is true.
hot_tub	bool	no	If property has hot tub.
hot_tub_desc	text	no	Description about hot tub, only fill when hot_tub is true.
washing_machine	bool	no	If property has washing machine for used of traveler.
washing_machine_desc	text	no	Description about washing machine, only fill when washing_machine is true.
parking	bool	no	If property has parking area.
parking_desc	text	no	Description about parking area, only fill when parking is true.
linens	bool	no	If rent include linens.
linens_desc	text	no	Description about linens, only fill when linens is true.
towels	bool	no	If rent include towels.
towels_desc	text	no	Description about towels, only fill when towels is true.
yard	bool	no	If property has yard.
yard_desc	text	no	Description about yard, only fill when yard is true.
deck	bool	no	If property has deck.
deck_desc	text	no	Description about deck, only fill when deck is true.
wood_stove	bool	no	If property has wood stove.
wood_stove_desc	text	no	Description about wood stove, only fill when wood_stove is true.
clothes_dryer	bool	no	If property has clothes dryer for use of traveler.
clothes_dryer_desc	text	no	Description about clothes dryer, only fill when clothes_dryer is true.
livingroom	bool	no	If property has livingroom for use of traveler.
livingroom_desc	text	no	Description about livingroom, only fill when livingroom is true.
senior_community	bool	no	If property is senior adults community.
senior_community_desc	text	no	Description about adults community, only fill when senior_communnity is true.
balcony	bool	no	If property has balcony.
balcony_desc	text	no	Description about balcony, only fill when balcony is true.
hairdryer	bool	no	If property has hair dryer for use of traveler.
ironboard	bool	no	If property has ironboard for use of traveler.

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 the user`	The user logged in is not the property's owner	"Sorry, you do not have access to that property!"
`R000`	`Fail`	The amenities were not updated
`R111`	`Success`	The operation was successful	[Update the amenities]
`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]
`VID184`	`Invalid input for amenity`	The amenity is not in [0, 1]	[Call the API again using a valid value for the amenity]
`VID185`	`Invalid input for amenity description`	The amenity description has more than 200 characters or it only has characters not allowed	"Please enter a valid description"