HomeEscape API

Service

Name	Add Traveler Booking
Description	Add a tentative reservation
Method	POST
URL	/traveler/booking
Example	/api/traveler/booking
Access	TRAVELER

HTTP Headers

Authorization	eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields	Type	Required	Description
property	number	yes	Property id
first_name	text	yes	Traveler's first name
last_name	text	yes	Traveler's last name
email	email	yes	Traveler's email
phone_code	number	yes	Country calling code
phone_number	number	yes	Phone number
check_in	date	yes	Tentative check in
check_out	date	yes	Tentative check out
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
message	text	no	Message for the property's owner

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."
`EC002`	`Property not found`	Property id doesn't match our records	"Sorry, We couldn't find that property!"
`EC011`	`Status not found`	Status: "tentative" doesn't match our records	"Oops! Looks like we hit a snag. Try closing the app and reopening it."
`EC024`	`Range of date not valid`	The range of date is not valid	Please enter valid dates
`EC025`	`Error when try to send email`	Error trying to send the email
`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"
`SC003`	`Invalid email address`	The email is not a valid email address	"email@domain" is not a valid email address"
`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]
`R000`	`Fail`	The reservation wasn't created
`R111`	`Success`	The operation was successful	"Your request to book has been submitted." [Come back to the property details]
`VID101`	`Invalid input for email`	Email is empty or it doesn't meet the email's format	"Please fill out this field" - "Please enter a valid email address (ex: email@homeescape.com)"
`VID104`	`Invalid input for phone_code`	Phone_code is empty or it doesn't have only numbers	"Please fill out this field" - "Phone code must have only numbers"
`VID105`	`Invalid input for phone_number`	Phone_number is empty or doesn't have only numbers	"Please fill out this field" - "Phone must have only numbers"
`VID106`	`Invalid input for first_name`	First name is empty or it doesn't have only letters	"Please fill out this field" - "First name must have only letters"
`VID107`	`Invalid input for last_name`	Last name is empty or it doesn't have only letters	"Please fill out this field" - "Last name must have only letters"
`VID112`	`Invalid input for property`	Property id is not a number	[Call the API again using a valid value for property id]
`VID150`	`Invalid input for message`	Message has only characters not allowed(" ", ', ’, ‘, ’, ", &, \, <, >, --)	"Please enter a valid message"
`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 empty or it is not a number	[Call the API again using a valid value for adults]
`VID230`	`Invalid input for children`	Children is empty or it is not a number	[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]