HomeEscape API

Service

Name	Get Traveler Reservation Details
Description	Get a message or reservation details
Method	GET
URL	/traveler/details/{reservation}?fields=[fields]
Example	/api/traveler/details/698455057?fields=property
Access	TRAVELER

HTTP Headers

Authorization	eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9...

Parameters

Fields	Type	Required	Description
reservation	number	yes	Reservation id
fields	text	no	Optional you can use this by retrieve complete object: property.

Response

            
                {
                        "id": "787224299",
                        "status": "Reserved",
                        "date_created": "2018-01-17T12:08:05-0500",
                        "check_in": "2018-01-20T00:00:00-0500",
                        "check_in_hour": "15",
                        "check_out": "2018-01-22T00:00:00-0500",
                        "check_out_hour": "11",
                        "nights": 2,
                        "adults": 1,
                        "children": 0,
                        "message": "Hello",
                        "price": 318,
                        "payment_type": 1,
                        "first_payment": 34.95,
                        "first_payment_date": "2018-03-02T14:01:23-0500",
                        "second_payment": 11.65,
                        "second_payment_date": "2018-02-07T00:00:00-0500",
                        "quote_total_USD": 46.6,
                        "damage_deposit_USD": 2,
                        "payment": true,
                        "payment_partial": false,
                        "payment_request": false,
                        "payment_request_online": false,
                        "property": "{}"
                        "quote": "{}"
                        "replies": "[]"
                }

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!"
`EC004`	`Not found result`	There are problems finding the data in our database	"No Record Found"
`EC031`	`Reservation not belong to that user`	The user logged in is not the reservation's traveler	"Sorry, We couldn't find that reservation!"
`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	[Call the API again using a valid value for reservation id]