| Name | Get Property Amenities |
|---|---|
| Description | Get the home's amenities of a property |
| Method | GET |
| URL | /properties/{property}/amenities |
| Example | /api/properties/11111111/amenities | Access | EVERYONE |
| Authorization | eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXUyJ9... |
|---|---|
| Fields | Type | Required | Description |
|---|---|---|---|
| property | number | yes | Property id |
{
"children": true,
"children_desc": "null",
"smoking": true,
"smoking_desc": "null",
"pets": "null",
"pets_desc": "null",
"wheelchair_accessible": true,
"wheelchair_accessible_desc": "null",
"long_termrenters": true,
"long_termrenters_desc": "null",
"minimum_age_rent": true,
"minimum_age_rent_desc": "null",
"events_allowed": true,
"events_allowed_desc": "null",
"airconditioned": true,
"airconditioned_desc": "null",
"excercise_room": true,
"excercise_room_desc": "null",
"fireplace": true,
"fireplace_desc": "null",
"garage": false,
"garage_desc": "null",
"heater": true,
"heater_desc": "null",
"private_pool": true,
"private_pool_desc": "null",
"telephone": true,
"telephone_desc": "null",
"hot_tub": true,
"hot_tub_desc": "null",
"washing_machine": true,
"washing_machine_desc": "null",
"parking": true,
"parking_desc": "null",
"linens": true,
"linens_desc": "null",
"towels": true,
"towels_desc": true,
"yard": true,
"yard_desc": "null",
"deck": true,
"deck_desc": "null",
"wood_stove": true,
"wood_stove_desc": true,
"clothes_dryer": true,
"clothes_dryer_desc": "null",
"livingroom": true,
"livingroom_desc": "null",
"senior_community": true,
"senior_community_desc": "null",
"balcony": true,
"balcony_desc": "null",
"hairdryer": true,
"ironboard": true
}
| 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!" |
EC002 |
Property not found |
Property id doesn't match our records | "Sorry, We couldn't find that 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] |
VID112 |
Invalid input for property |
Property id is not a number | [Call the API again using a valid value for property id] |