HomeEscape API

Service

Name	Get Property Kitchens
Description	Get the kitchen's amenities of a property
Method	GET
URL	/properties/{property}/kitchens
Example	/api/properties/11111111/kitchens
Access	EVERYONE

HTTP Headers

Authorization	eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields	Type	Required	Description
property	number	yes	Property id

Response

            
                {
                    "kitchen": true,
                    "kitchen_desc": "null",
                    "kitchen_utensils": true,
                    "kitchen_utensils_desc": "null",
                    "refrigerator": true,
                    "refrigerator_desc": "null",
                    "blender": true,
                    "blender_desc": "null",
                    "freezer": true,
                    "freezer_desc": "null",
                    "microwave": true,
                    "microwave_desc": "null",
                    "dishwasher": true,
                    "dishwasher_desc": "null",
                    "toaster": true,
                    "toaster_desc": "null",
                    "coffe_maker": true,
                    "coffe_maker_desc": "null",
                    "stove": true,
                    "stove_desc": "null",
                    "oven": true,
                    "oven_desc": "null",
                    "garbage_disposal": true,
                    "garbage_disposal_desc": "null",
                    "grill": true,
                    "grill_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]