HomeEscape API

Service

Name	Edit Reservation
Description	Edit a reservation
Method	PUT
URL	/reservations/{reservation}
Example	/api/reservations/123456789
Access	OWNER, MANAGER

HTTP Headers

Authorization	eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields	Type	Required	Description
reservation	number	yes	Reservation id.
first_name	text	yes	First name of the traveler.
last_name	text	yes	Last name of the traveler.
email	email	yes	Email of the traveler.
phone_code	number	yes	Country calling code.
phone_number	number	yes	Number of the phone.
check_in	date	yes	Tentative check in.
check_in_hour	number	yes	Tentative time to check in, value between 0 a 23.
check_out	date	yes	Tentative check out.
check_out_hour	number	yes	Tentative time to check out, value between 0 a 23.
adults	number	yes	How many adults.
children	number	yes	How many children.
notes	text	yes	Question for the owner.
status	text	yes	Values: reserved, tentative, blocked, cancelled.

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!"
`EC003`	`Reservation not found`	Reservation id doesn't match our records	"Sorry, We couldn't find that reservation!"
`EC011`	`Status not found`	Status 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 a valid range of 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"
`EC031`	`Reservation not belong to that user`	The user logged in is not the reservation traveler or the owner	"Sorry, you do not have access to that reservation!"
`R000`	`Fail`	The reservation wasn't updated
`R111`	`Success`	The operation was successful	"The reservation was updated successfully"
`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]
`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 doesn't have only numbers	"Phone code must have only numbers"
`VID105`	`Invalid input for phone_number`	Phone_number doesn't have only numbers	"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	"Sorry, We couldn't find that property!"
`VID183`	`Invalid input for notes`	Notes has only characters not allowed(" ", ', ’, ‘, ’, ", &, \, <, >, --)	"Please enter a valid text for Notes"
`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"
`VID220`	`Invalid input for status`	Status is not in ["reserved", "blocked", "tentative"]	[Call the API again using a valid value for status]
`VID229`	`Invalid input for adults`	Adults is empty or it is not a number	[Call the API again using a valid value for adults] - "Please select an item in the list"
`VID230`	`Invalid input for children`	Children is empty or it is not a number	[Call the API again using a valid value for children] - "Please select an item in the list"
`VID231`	`Invalid input for check_in_hour`	Check_in_hour is not a number between 0-23	[Call the API again using a valid value for check_in_hour] - "Please select an item in the list"
`VID232`	`Invalid input for check_out_hour`	Check_out_hour is not a number between 0-23	[Call the API again using a valid value for check_out_hour] - "Please select an item in the list"
`VID234`	`Invalid input for reservation`	Reservation id is not a number	"Sorry, We couldn't find that reservation!" - [Call the API again using a valid value for reservation id]