{{ wiki:www.travanto.de.png}} \\ \\ \\ \\ ====== Amenities====== Pushing amenities will enhance your properties significantly by providing additional relevant information for your guests. Most of our amenities take the boolean data type, some are of a different nature. The so called multi-amenities can only take one value out of an array of possible values. Examples can be found in the amenity overview table below. The general URL of this service is https://connect.travanto.de/service/objects/amenities. Use GET method to show set amenities and PUT method to create, change or delete one or more amenities. The [[api:services:schemata:amenities|basic request and response schemes]] for the amenities service provide you with a sound idea of how to use it. Amentities service request scheme\\ Amentities service response scheme * If you cannot map one of your amenities to a corresponding one in our system, you could simply add those as plain text to the interior_info or whatever text field suits using the [[api:services:descriptions|ObjectDescription service]]. * We will add additional amenities to the existing ones in the near future. \\ ---- ===== List of possible amenities ===== *Mandatory ^ Amenity ^ Category ^ Type ^ Possible values ^ Description ^ | wheelchair_accessible* |General | Boolean | 0,1 |Is your property accessible for impaired or disabled people? | | smoking_allowed* |General | Boolean | 0,1 | Smoking or non-smoking | | suitable_for_the_elderly |General | Boolean | 0,1 |Is your property safe to use for elderly people? No stairs, spacious rooms... | | suitable_for_allergy_sufferers |General | Boolean | 0,1 | No pets allowed if activated | | Internet* |General | Multi/String |internet_with_wlan, internet_without_wlan, no_internet |WiFi, cable internet or no internet at all? | | Pets* |General | Multi/String |no_pets, all, dogs, small_dogs, small_animals_no_dogs_or_cats, small_animals_dogs_and_cats |Please specify what kind of animals you allow | | | | | | | | | | | | | | Kitchen* |Kitchen | Multi/String |separate_kitchen, kitchenette, no_kitchen |WiFi, cable internet or no internet at all? | | Dishwasher* |Kitchen | Boolean | 0,1 | Dish washer on site | | Oven |Kitchen | Boolean | 0,1 | Oven provided | | Freezer |Kitchen | Boolean | 0,1 | Freezer on site | | Stove |Kitchen | Boolean | 0,1 | | | Coffee_machine |Kitchen | Boolean | 0,1 | | | Fridge |Kitchen | Boolean | 0,1 | | | Microwave |Kitchen | Boolean | 0,1 | | | Toaster |Kitchen | Boolean | 0,1 | | | High_chair |Kitchen | Boolean | 0,1 | | | | | | | | | | | | | | | Bathroom_shower_tube |Bathroom | Boolean | 0,1 | Is there a bathroom with tube and shower? | | Bathroom_shower |Bathroom| Boolean | 0,1 | This is a bathroom with just a shower | | guest_bathroom |Bathroom| Boolean | 0,1 | Additional restroom | | hairdryer |Bathroom | Boolean | 0,1 | Hairdryer available | | | | | | | | | | | | | | Parking* |Exterior | Boolean | 0,1 | Car parking possibilities? | | Balcony |Exterior | Boolean | 0,1 | | | Bicycles |Exterior | Boolean | 0,1 | Do you have bicycles to rent out? | | Garage |Exterior | Boolean | 0,1 | Is there a garage or a carport? | | Garden |Exterior | Boolean | 0,1 | | | Garden_furniture |Exterior | Boolean | 0,1 | | | Barbecue_grill |Exterior | Boolean | 0,1 | | | Sea_lake_view|Exterior | Boolean | 0,1 | | | Thatched_roof |Exterior | Boolean | 0,1 | | | Terrace_patio |Exterior | Boolean | 0,1 | | | Playground |Exterior | Boolean | 0,1 | | | | | | | | | | | | | | | Fitness |Wellness | Boolean | 0,1 | | | Sauna |Wellness | Boolean | 0,1 | | | Jacuzzi |Wellness | Boolean | 0,1 | | | Sunbed |Wellness | Boolean | 0,1 | | | Wellness_treatment |Wellness | Boolean | 0,1 | | | Swimming_pool |Wellness | Boolean | 0,1 | | | | | | | | | | | | | | | Lift |Miscellaneous | Boolean | 0,1 | | | Air_conditioning |Miscellaneous | Boolean | 0,1 | | | Washing_machine |Miscellaneous | Boolean | 0,1 | | | Clothes_dryer |Miscellaneous | Boolean | 0,1 | | \\ ---- ===== Showing amentities ===== ^ Method ^ URL ^ Description ^ | GET |/service/objects/amenities/$object_id | Show all amenities for one specific property | | GET |/service/objects/amenities/ | Show all amenities for all the properties accessible with your API key | Example response: [json] { "OK": 1, "Request": { "Method": "GET", "Path": "/service/objects/properties/1010397" }, "ObjectsAmenitiesServiceResult": [ { "object_id": 1010397, "amenities": { "wheelchair_accessible": 1, "terrace_patio": 1, "stove": 1, "fireplace": 1, "bathroom_shower_tube": 0, "bathroom_shower": 0, "guest_bathroom": 1, "jacuzzi": 1, "sunbed": 1, "fitness": 1, "thatched_roof": 1, "playground": 1, "bicycles": 1, "parking": 1, "garden_furniture": 1, "suitable_for_the_elderly": 1, "highchair": 1, "child_friendly": 1, "clothes_dryer": 1, "suitable_for_allergy_sufferers": 0, "barbecue_grill": 1, "washing_machine": 1, "swimming_pool": 1, "sauna": 1, "oven": 1, "microwave": 1, "garden": 1, "sea_river_view": 1, "fridge": 1, "hi_fi_system": 1, "dishwasher": 1, "dvd_blue_ray_player": 1, "garage": 1, "balcony": 1, "air_conditioning": 1, "wellness_treatment": 1, "tv": 1, "lift": 1, "hairdryer": 0, "coffee_machine": 0, "freezer": 1, "toaster": 1, "smoking_allowed": 1, "multi": { "pets": "small_dogs", "internet": "internet_with_wlan", "kitchen": "separate_kitchen" }, "holiday_category": { "dog": 1, "wintersport": 1, "farm": 1, "lakeside": 1, "beach": 0 } } } ] } [/json] TIPS * Using this request you can activate certain holiday categories. The corresponding descriptions have to be set using the DescriptionsService. \\ ---- ===== Creating/updating/deleting amenities ===== If you want to update or delete your amenities you can do so using the following request. ^ Method ^ URL ^ Description ^ | PUT |/service/objects/amenties/$object_id | Update amenities for one specific property | | PUT |/service/objects/amenities| Update amenities for one or more properties | Example request: [json] { "objects": [ { "object_id": 1010397, "amenities": { "wheelchair_accessible": 0, "terrace_patio": 1, "stove": 1, "fireplace": 1, "bathroom_shower_tube": 0, "bathroom_shower": 0, "guest_bathroom": 1, "jacuzzi": 1, "sunbed": 1, "fitness": 1, "thatched_roof": 1, "playground": 1, "bicycles": 0, "parking": 1, "garden_furniture": 1, "suitable_for_the_elderly": 1, "highchair": 1, "child_friendly": 1, "clothes_dryer": 1, "suitable_for_allergy_sufferers": 0, "barbecue_grill": 1, "washing_machine": 1, "swimming_pool": 1, "sauna": 1, "oven": 1, "microwave": 1, "garden": 1, "sea_river_view": 1, "fridge": 1, "hi_fi_system": 1, "dishwasher": 1, "dvd_blue_ray_player": 1, "garage": 1, "balcony": 1, "air_conditioning": 1, "wellness_treatment": 1, "tv": 1, "lift": 1, "hairdryer": 0, "coffee_machine": 0, "freezer": 1, "toaster": 1, "smoking_allowed": 1, "multi": { "pets": "small_dogs", "internet": "internet_with_wlan", "kitchen": "separate_kitchen" }, "holiday_category": { "dog": 1, "wintersport": 1, "farm": 1, "lakeside": 1, "beach": 0 } } } ] } [/json] Example response: [json] { "OK": 1, "Request": { "Method": "GET", "Path": "/service/objects/properties/1010397" }, "ObjectsAmenitiesServiceResult": [ { "object_id": 1010397, "amenities": { "wheelchair_accessible": 0, "terrace_patio": 1, "stove": 1, "fireplace": 1, "bathroom_shower_tube": 0, "bathroom_shower": 0, "guest_bathroom": 1, "jacuzzi": 1, "sunbed": 1, "fitness": 1, "thatched_roof": 1, "playground": 1, "bicycles": 0, "parking": 1, "garden_furniture": 1, "suitable_for_the_elderly": 1, "highchair": 1, "child_friendly": 1, "clothes_dryer": 1, "suitable_for_allergy_sufferers": 0, "barbecue_grill": 1, "washing_machine": 1, "swimming_pool": 1, "sauna": 1, "oven": 1, "microwave": 1, "garden": 1, "sea_river_view": 1, "fridge": 1, "hi_fi_system": 1, "dishwasher": 1, "dvd_blue_ray_player": 1, "garage": 1, "balcony": 1, "air_conditioning": 1, "wellness_treatment": 1, "tv": 1, "lift": 1, "hairdryer": 0, "coffee_machine": 0, "freezer": 1, "toaster": 1, "smoking_allowed": 1, "multi": { "pets": "small_dogs", "internet": "internet_with_wlan", "kitchen": "separate_kitchen" }, "holiday_category": { "dog": 1, "wintersport": 1, "farm": 1, "lakeside": 1, "beach": 0 } } } ] } [/json] TIPS * Please always send all amenities set for your property even if you just want to add a new one. Omitting an amenity will deactivate it.