HomeEscape API

Service

Name	Check Price
Description	Get a quote for a property
Method	GET
URL	/properties/{property}/check-price?check_in={date}&check_out={date}&adults={number}&children={number}&pets={bool}
Example	/api/properties/55853851/check-price?check_in=07/07/2016&check_out=07/10/2016&adults=1&children=0&pets=0
Access	EVERYONE

HTTP Headers

Authorization	eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields	Type	Required	Description
property	number	yes	Property id
check_in	date	yes	Reservation starting date
check_out	date	yes	Reservation ending date
adults	number	yes	Number of adults, by default 1
children	number	yes	Number of children, by default 0
pets	bool	yes	If the traveler has pets or not, by default 0

Response

            
                {
                     "nights": "3",
                     "price": "105",
                     "sales_tax": "10.5",
                     "lodging_tax": "10.5",
                     "pet_fee": "50",
                     "cleaning_fee": "20",
                     "guest_charge": "0",
                     "guest_fee": "25",
                     "fee0_name": "null",
                     "fee0": "0",
                     "fee1_name": "null",
                     "fee1": "0",
                     "fee2_name": "null",
                     "fee2": "0",
                     "fee3_name": "null",
                     "fee3": "0",
                     "fee4_name": "null",
                     "fee4": "0",
                     "damage_deposit": 100,
                     "damage_deposit_hold": true,
                     "damage_deposit_hold_days": 7,
                     "price_total": 246,
                     "price_total_USD": 246
                   }

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."
`EC002`	`Property not found`	Property id doesn't match our records	"Sorry, We couldn't find that property!"
`EC024`	`Range of date not valid`	The range of date is not valid	Please enter valid dates
`EC028`	`Reservation no available in that date`	The reservation's dates are not available	"This property is not available on these dates"
`EC047`	`"Maximum of "x" guests allowed"`	The number of allowed guests of the property is less than the quantity requested by the guest	"Maximum of "[ x ]" guests allowed"
`EC048`	`"This property requires a minimum stay of "x" nights"`	The minimum of nights the property required is more than the nights requested by the guest	"This property requires a minimum stay of "[ x ]" nights"
`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]
`VID202`	`Invalid input for check_in`	Check_in doesn't meet the date's format	"Please enter a valid Check In date"
`VID203`	`Invalid input for check_out`	Check_out doesn't meet the date's format	"Please enter a valid Check Out date"
`VID229`	`Invalid input for adults`	Adults is not a number or it is less than 1	[Call the API again using a valid value for adults]
`VID230`	`Invalid input for children`	Children is not a number or it is less than 0	[Call the API again using a valid value for children]
`VID259`	`Invalid input for pets`	Pets is not in [0,1]	[Call the API again using a valid value for pets]