Name | Get Reservation |
---|---|
Description | Get a reservation |
Method | GET |
URL | /reservations/{reservation} |
Example | /api/reservations/123456789 | Access | OWNER, MANAGER, TRAVELER |
Authorization | eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9... |
---|---|
Fields | Type | Required | Description |
---|---|---|---|
reservation | number | yes | Reservation id |
{
"id": "531749228",
"date_created": "2017-05-04T16:55:22-0400",
"check_in": "2017-05-07T00:00:00-0400",
"check_in_hour": "13",
"check_out": "2017-05-10T00:00:00-0400",
"check_out_hour": "11",
"nights": "null",
"adults": 2,
"children": 0,
"message": "null",
"status": "Reserved",
"guest": "Traveler Developer",
"email": "dev4@telxweb.com",
"phone_code": "1",
"phone_number": "7863334444",
"property": "33446017",
"property_name": "My Second Home",
"nights_price_total": "600",
"cleaning_fee": "null",
"pet_fee": "null",
"lodging_tax": "null",
"sales_tax": "null",
"refundable_damage": "null",
"add_guest": "null",
"guest_fee": "null",
"fee0_name": "null",
"fee0": "null",
"fee1_name": "null",
"fee1": "null",
"fee2_name": "null",
"fee2": "null",
"fee3_name": "null",
"fee3": "null",
"fee4_name": "null",
"fee4": "null",
"quote_total": "null",
"payment": false,
"payment_request": true,
"payment_request_online": false,
"currency_symbol": "$",
"payment_type": 0,
"first_payment": 0,
"first_payment_date": "2017-06-07T15:47:19-0400",
"second_payment": "null",
"second_payment_date": "null",
"quote_total_USD": 0,
"damage_deposit_USD": 0,
"deposit_account": true,
"paypal_account": false
}
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 traveler or the owner | "Sorry, you do not have access to 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] |