| Name | Get Favorite Properties |
|---|---|
| Description | Get the favorite properties of the traveler |
| Method | GET |
| URL | /traveler/favorites[?page=[page]&per_page=[per_page]] |
| Example | /api/traveler/favorites | Access | TRAVELER |
| Authorization | eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9... |
|---|---|
| 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. |
{
"items_total": "5",
"items": [
{
"id": "00000000",
"name": "Best Home",
"tagline": "The Best Home In Miami Beach Since 1959.",
"description": "Good apartment localized in Ocean Dr, front to most popular beach ...",
"size": "1000",
"size_unit": 0,
"property_type": "Apartment",
"location_types": [
"Near The Ocean",
"Beach"
],
"bedrooms": 1,
"bathrooms": 1,
"half_bath": 0,
"sleeps": 4,
"currency": "USD",
"bedding": "2 bunk bed",
"purchased": "null",
"why_this": "null",
"benefits": "null",
"views": 1378,
"reviews_av": 4,
"reviews_total": 9,
"status": "active",
"luxury": false,
"favorite": 1,
"featured": false,
"subscribed": false,
"min_price": 100,
"location": {
"address": "6345 Collins Ave, Miami Beach, FL 33141",
"latitude": "25.845224000000",
"longitude": "-80.119744000000",
"country": "USA",
"state": "Florida",
"city": "Miami Beach",
"neighborhood": "null",
"postal_code": "33141",
"show_map": true
},
"images": [
{
"id": 3405,
"description": "null",
"image": "http://dev.homeescape.com/uploads/images/335/46415000/medium/HE-66065-7059706.jpg"
},
...
]
"owner": {
"name": "Pelican",
"photo": "http://dev.homeescape.com/uploads/images/2106/HE-2106-466767124832.jpg"
}
},
...
]
}
| 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" - [Don't fulfill any favorite icon over the property] |
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] |