HomeEscape API

Service

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

HTTP Headers

Authorization	eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields	Type	Required	Description
property	number	yes	Property id

Response

            
                {
                    "television": true,
                    "television_desc": "null",
                    "cable": true,
                    "cable_desc": "null",
                    "stereo": true,
                    "stereo_desc": "null",
                    "music_library": true,
                    "music_library_desc": "null",
                    "premiun_channels": true,
                    "premiun_channels_desc": "null",
                    "internet_access": true,
                    "internet_access_desc": "null",
                    "wireless_internet_access": true,
                    "wireless_internet_access_desc": "null",
                    "video_games": true,
                    "video_games_desc": "null",
                    "video_library": true,
                    "video_library_desc": "null",
                    "toys": true,
                    "toys_desc": "null",
                    "board_games": true,
                    "board_games_desc": "null",
                    "books": true,
                    "books_desc": "null",
                    "pooltable": true,
                    "pooltable_desc": "null",
                    "communal_pool": true,
                    "communal_pool_desc": "null",
                    "sauna": true,
                    "sauna_desc": "null",
                    "indoor_pool": true,
                    "indoor_pool_desc": "null",
                    "heated_pool": true,
                    "heated_pool_desc": "null"
                }

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]