HomeEscape API

Service

Name	Edit Owner Traveler
Description	Edit a traveler to the list of travelers hosted at the owner's properties
Method	PUT
URL	/owner/travelers/{traveler}
Example	/api/owner/travelers/{traveler}
Access	OWNER, MANAGER

HTTP Headers

Authorization	eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields	Type	Required	Description
traveler	number	yes	Id of the owner's traveler that will be removed from the list
name	text	yes	Full name of the owner's traveler
email	text	yes	Email of the owner's traveler
phone	number	no	Phone number of the owner's traveler

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!"
`EC042`	`Traveler not found`	Traveler id doesn't match our records	"Sorry, We couldn't find that traveler!"
`EC043`	`Email had been registered before`	Another owner's traveler in our database is using that email	"This email is already in your Travelers List"
`R000`	`Fail`	The owner's traveler wasn't updated
`R111`	`Success`	The operation was successful	[Update the traveler's list, hide loading icon]
`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]
`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)"
`VID105`	`Invalid input for phone_number`	Phone_number doesn't have only numbers	"Phone must have only numbers"
`VID109`	`Invalid input for traveler`	Traveler id doesn't have only numbers	"Sorry, We couldn't find that traveler!"
`VID130`	`Invalid input for name`	Name is empty or it doesn't have only letters	"Please fill out this field" - "Name must have only letters"