HomeEscape API

Service

Name	Get Traveler Inbox
Description	Get a list of the messages
Method	GET
URL	/traveler/inbox?page=[page]&per_page=[per_page]&status=[status]&unread=[unread]&fields=[fields]
Example	/api/traveler/inbox?page=&per_page=&status=all&unread=0&fields=
Access	TRAVELER

HTTP Headers

Authorization	eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields	Type	Required	Description
page	number	no	It can be used to paginate the result. By default 0 returns all.
per_page	number	no	It can be used to limit the result. By default 10 items per page. If page = 0, this field doesn't apply.
status	text	no	By default "all" return all, "reserved", "tentative", "cancelled".
unread	number	no	By default 0 return all, 1 only return unread.
fields	text	no	Optional you can use this by retrieve complete object: property.

Response

            
                {
                    "items_total": "5",
                    "items": [
                        {                            
                            "id": "810013413",
                            "status": "Cancelled",
                            "date_created": "2018-01-11T03:41:55-0500",
                            "check_in": "2018-01-11T00:00:00-0500",
                            "check_in_hour": "15",
                            "check_out": "2018-01-25T00:00:00-0500",
                            "check_out_hour": "11",
                            "nights": 14,
                            "adults": 1,
                            "children": 0,
                            "message": "fine",
                            "price": 0,
                            "payment": false,
                            "payment_partial": false,
                            "payment_request": false,
                            "payment_request_online": true,
                            "property": "92264472",
                        },
                       ...
                    ]
                }

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!"
`EC004`	`Not found result`	There are problems finding the data in our database	"No Record Found"
`EC011`	`Status not found`	The status doesn't match our records	"Oops! Looks like we hit a snag. Try closing the app and reopening it."
`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]
`VID110`	`Invalid input for page`	Page is not a number	[Call the API again using a valid value for page]
`VID111`	`Invalid input for per_page`	Per_page is not a number	[Call the API again using a valid value for per_page]
`VID220`	`Invalid input for status`	Status is not in ["all", "reserved", "tentative", "cancelled"]	[Call the API again using a valid value for status]
`VID222`	`Invalid input for unread`	Unread is not in [0,1]	[Call the API again using a valid value for unread]