| Name | Get Top Features |
|---|---|
| Description | Returns the properties showed as top featured in the home page |
| Method | GET |
| URL | /top/features |
| Example | /api/top/features | Access | EVERYONE |
| 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 20 items per page. If page = 0, this field doesn't apply. |
{
"items_total": 19,
"items": [
{
"id": "28577000",
"name": "Das Bärenhaus",
"tagline": "1920s Bungalow Retreat - Downtown Tampa & Ybor City Areas",
"description": "Located one mile north of ...",
"size": "1592",
"size_unit": 0,
"property_type": "Home",
"location_types": [
"Downtown",
"Waterfront"
],
"bedrooms": 1,
"bathrooms": 2,
"half_bath": 0,
"sleeps": 2,
"currency": "USD",
"bedding": "Guest Suite Only - kitchen and living room shared ...",
"purchased": "2003",
"benefits": "Guest Suite Only - kitchen and living room shared ...",
"why_this": "A quaint Tampa Heights neighborhood undergoing ... ",
"views": 4596,
"reviews_av": 0,
"reviews_total": 0,
"status": "active",
"luxury": false,
"favorite": 0,
"featured": true,
"subscribed": false,
"min_price": 79,
"location": {
"address": "104 E Woodlawn Ave, Tampa, FL, United States",
"latitude": "27.976247000000",
"longitude": "-82.460778000000",
"country": "USA",
"state": "Florida",
"city": "Tampa",
"neighborhood": "Tampa Heights",
"postal_code": "33603",
"show_map": true
},
"images": [
{
"id": 29690,
"description": "null",
"image": "http://dev.homeescape.com/.../79969.jpg"
}, { ... }
],
"owner": {
"name": "Ken",
"photo": "http://dev.homeescape.com/.../IMG_8186.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." |
EC004 |
Not found result |
There are problems finding the data in our database | [Don't show Top Featured section] |
SC006 |
User no authorization |
The token is not valid for use our API services | "Access Denied. Try contacting the support team." |
SC014 |
Expired token |
The token has expired | "Access Denied. Try contacting the support team." |
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] |