HomeEscape API

Service

Name	Mark Reservation As Read
Description	Mark a reservation as viewed by the owner or by the traveler
Method	PATCH
URL	/reservations/{reservation}/mark_as_read
Example	/api/reservations/123456789/mark_as_read
Access	OWNER, MANAGER, TRAVELER

Authorization	eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Fields	Type	Required	Description
reservation	number	yes	Reservation id.

            
                {
                    "code": "R111",
                    "message": "Success"
                }

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!"
`EC031`	`Reservation not belong to that user`	The user logged in is not the reservation owner	"Sorry, you do not have access to that reservation!"
`R000`	`Fail`	The reservation wasn't mark as read	[Keep the reservation marked as unread]
`R111`	`Success`	The reservation change was successful	[Mark the reservation as read]
`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]
`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]