HomeEscape API

Service

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

HTTP Headers

Authorization	eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields	Type	Required	Description
property	number	yes	Property id.
television	bool	no	If property has tv.
television_desc	text	no	Description about tv, only fill when television is true.
cable	bool	no	If property has television cable.
cable_desc	text	no	Description about television cable, only fill when cable is true.
stereo	bool	no	If property has stereo.
stereo_desc	text	no	Description about stereo, only fill when stereo is true.
music_library	bool	no	If property has music library.
music_library_desc	text	no	Description about music library, only fill when music_library is true.
premiun_channels	bool	no	If property has premiun channels.
premiun_channels_desc	text	no	Description about premiun channels, only fill premiun_channels is true.
wireless_internet_access	bool	no	If property has wifi.
wireless_internet_access_desc	text	no	Description about wifi, only fill when wireless_internet_access is true.
video_games	bool	no	If property has video games.
video_games_desc	text	no	Description about video games, only fill when video_games is true.
video_library	bool	no	If property has video library.
video_library_desc	text	no	Description about video library, only fill when video_library is true.
toys	bool	no	If property has toys.
toys_desc	text	no	Description about toys, only fill when toys is true.
board_games	bool	no	If property has board games.
board_games_desc	text	no	Description about board games, only fill when board_games is true.
books	bool	no	If property has books.
books_desc	text	no	Description about books, only fill when books is true.
pooltable	bool	no	If property has pooltable.
pooltable_desc	text	no	Description about pooltable, only fill when pooltable is true.
communal_pool	bool	no	If property has communal pool.
communal_pool_desc	text	no	Description about communal pool, only fill when communal pool is true.
sauna	bool	no	If property has sauna.
sauna_desc	text	no	Description about sauna, only fill when sauna is true.
indoor_pool	bool	no	If property has indoor pool.
indoor_pool_desc	text	no	Description about indoor pool, only fill when indoor_pool is true.
heated_pool	bool	no	If property has heated pool.
heated_pool_desc	text	no	Description about heated pool, only fill when heated_pool is true.
internet_access	bool	no	If property has internet access.
internet_access_desc	text	no	Description about internet access, only fill when internet_access is true.

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 entertainments were not updated
`R111`	`Success`	The operation was successful	[Update the entertainments]
`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 entertainment is not in [0, 1]	[Call the API again using a valid value for the entertainment]
`VID185`	`Invalid input for amenity description`	The entertainment description has more than 200 characters or it only has characters not allowed	"Please enter a valid description"