User Tools

Site Tools


api:services:descriptions





Descriptions

You can also send descriptions of your properties right into our system. There are various descriptions available.

The general URL of this service is https://connect.travanto.de/service/objects/descriptions. Use GET method to show current and PUT method to create, change or delete one or more descriptions.

The basic request and response schemes for the descriptions service provide you with a sound idea of how to use it.



List of possible descriptions

*mandatory

Description Explanation Restrictions
short_description* Used to describe the property in a few sentences. Shown in search results and on top of the presentation Max. 255 characters
exterior_info* Used to describe to immediate exterior of your property such as the terrace garden, outdoor pool and so forth Recommended length between 150-300 words
location_info* Used to describe to surroundings such as sights, places to visit, the beach and other places of interest Recommended length between 150-300 words
interior_info* Used to describe all your rooms and the proportions of your property. What makes it special, what are the highlights? Recommended length between 150-300 words
additional_info Used to provide addtitional information you would like to share Recommended length between 150-300 words
special_features Used to provide guest with information about special circumstances or peculiarities of your property
price_info Do you have any additional information concerning prices? Please mention a compulsory deposit and/or the visitor tax. Will be implemented within the price calculation soon n.a.
tenant_info Would you like to share some information with your guest after they have booked your property? Provide them here. Only applicable for directly bookable properties, max. 1000 characters
holiday_category_dog If dogs are allowed, you can share some more information for guests travelling with dogs Recommended length between 150-300 words
holiday_category_wintersport Is your destionation attractive for guests doing skiing oder snowboarding? Please provide some additional information here Recommended length between 150-300 words
holiday_category_farm Do you rent out a room on a farm? Addtitional information for your guest would be great. Recommended length between 150-300 words
holiday_category_lake Situated at a lake? Describe why it is the place to be. Recommended length between 150-300 words
holiday_category_sea Situated at the sea? Describe why it is the place to be. Recommended length between 150-300 words
holiday_category_beach Great beach in walking distance? Recommended length between 150-300 words



Creating, updating and deleting descriptions

If you want to create, update or delete certain description, please use this request. It is possible to update only on e property or all of your accessible properties at the same time.

Method URL Description
PUT /service/objects/descriptions/$object_id Create, update or delete descriptions for one specific property
PUT /service/objects/descriptions/ Create, update or delete descriptions for all properties accessible with your API key

Example request:

{
  "objects": [
    {
      "object_id": 1010397,
      "descriptions": {
        "short_description": {
          "en": "",
          "de": "Komfortabel ausgestattete Ferienwohnung ca. 60 qm auf zwei Ebenen. 1 Wohnraum mit großzügigem Essbereich, 1 geschmackvoll und komplett ausgestattete Küche, 2 Schlafräume sowie ein schönes freundliches Bad stehen zur Verfügung. Eigene Terrasse. Wlan"
        },
        "exterior_info": {
          "en": "",
          "de": "Für Ihr Auto steht ein PKW-Stellplatz zur Verfügung. Terrasse mit Gartenmöbeln ist vorhanden."
        },
        "location_info": {
          "en": "",
          "de": "Das im Jahre 1996 erbaute Friesenhaus mit 4 Ferienwohnungen befindet sich in Alt Westerland. Sie gehen nur 15 Minuten bis zum Strand oder zum Freizeitbad Sylter Welleund nur ca. 10 Minuten bis in das Stadtzentrum. Der Bahnhof befindet sich ungefähr 5 Minuten entfernt. Durch seine günstige Lage ist das Haus der ideale Ausgangspunkt für die vielfachen und interresanten Möglichkeiten auf Sylt den Urlaub zu erleben. Direkt an der befahrenen Keitumer-Landstraße gelegen."
        },
        "interior_info": {
          "en": "",
          "de": "Dieses 60 qm große Appartement hat 3 Zimmer über zwei Ebenen EG/UG, einen Wohnraum mit großzügigem Essbereich und eine geschmackvoll und komplett ausgestattete Küche, zwei Schlafräume sowie ein schönes freundliches Bad. Kostenloser WLAN Zugang, Kabel-TV, Radio"
        },
        "additional_info": {
          "en": "",
          "de": "Haustiere sind leider nicht erlaubt. Nichtraucher oder auf der Terrasse"
        },
        "special_features": {
          "en": "",
          "de": "Fußbodenheizung im Badezimmer"
        },
        "price_info": {
          "en": "",
          "de": "Wäschepaket: Bett bezogen 2 Badehandtücher ,2 kleine Handtücher, Duschvorleger und Geschirrtuch pro Person"
        },
        "tenant_info": {
          "en": "",
          "de": "Die Schlüsselübergabe findet bei uuns im Büro in der Musterstr. 25 statt"
        },
        "holiday_category_dog": {
          "en": "",
          "de": "Hunde sind sehr willkommen und können sich hier frei bewegen. Fressnapf und Hundehütte stehen bereit."
        },
        "holiday_category_wintersport": {
          "en": "",
          "de": "Skilift in nur 200m Entfernung."
        },
        "holiday_category_farm": {
          "en": "",
          "de": "Hier gibt es Kühe, Schweine und Gänse. Wir haben Tiere aller Art."
        },
        "holiday_category_lake": {
          "en": "",
          "de": "Hier kann man sich komplett erholen und entspannen"
        },
        "holiday_category_sea": {
          "en": "",
          "de": ""
        },
        "holiday_category_beach": {
          "en": "",
          "de": "Traumstrand vor der Haustür."
        }
      }
    }
  ]
}

Example response:

{
  "objects": [
    {
      "object_id": 1010397,
      "descriptions": {
        "short_description": {
          "en": "",
          "de": "Komfortabel ausgestattete Ferienwohnung ca. 60 qm auf zwei Ebenen. 1 Wohnraum mit großzügigem Essbereich, 1 geschmackvoll und komplett ausgestattete Küche, 2 Schlafräume sowie ein schönes freundliches Bad stehen zur Verfügung. Eigene Terrasse. Wlan"
        },
        "exterior_info": {
          "en": "",
          "de": "Für Ihr Auto steht ein PKW-Stellplatz zur Verfügung. Terrasse mit Gartenmöbeln ist vorhanden."
        },
        "location_info": {
          "en": "",
          "de": "Das im Jahre 1996 erbaute Friesenhaus mit 4 Ferienwohnungen befindet sich in Alt Westerland. Sie gehen nur 15 Minuten bis zum Strand oder zum Freizeitbad Sylter Welleund nur ca. 10 Minuten bis in das Stadtzentrum. Der Bahnhof befindet sich ungefähr 5 Minuten entfernt. Durch seine günstige Lage ist das Haus der ideale Ausgangspunkt für die vielfachen und interresanten Möglichkeiten auf Sylt den Urlaub zu erleben. Direkt an der befahrenen Keitumer-Landstraße gelegen."
        },
        "interior_info": {
          "en": "",
          "de": "Dieses 60 qm große Appartement hat 3 Zimmer über zwei Ebenen EG/UG, einen Wohnraum mit großzügigem Essbereich und eine geschmackvoll und komplett ausgestattete Küche, zwei Schlafräume sowie ein schönes freundliches Bad. Kostenloser WLAN Zugang, Kabel-TV, Radio"
        },
        "additional_info": {
          "en": "",
          "de": "Haustiere sind leider nicht erlaubt. Nichtraucher oder auf der Terrasse"
        },
        "special_features": {
          "en": "",
          "de": "Fußbodenheizung im Badezimmer"
        },
        "price_info": {
          "en": "",
          "de": "Wäschepaket: Bett bezogen 2 Badehandtücher ,2 kleine Handtücher, Duschvorleger und Geschirrtuch pro Person"
        },
        "tenant_info": {
          "en": "",
          "de": "Die Schlüsselübergabe findet bei uuns im Büro in der Musterstr. 25 statt"
        },
        "holiday_category_dog": {
          "en": "",
          "de": "Hunde sind sehr willkommen und können sich hier frei bewegen. Fressnapf und Hundehütte stehen bereit."
        },
        "holiday_category_wintersport": {
          "en": "",
          "de": "Skilift in nur 200m Entfernung."
        },
        "holiday_category_farm": {
          "en": "",
          "de": "Hier gibt es Kühe, Schweine und Gänse. Wir haben Tiere aller Art."
        },
        "holiday_category_lake": {
          "en": "",
          "de": "Hier kann man sich komplett erholen und entspannen"
        },
        "holiday_category_sea": {
          "en": "",
          "de": ""
        },
        "holiday_category_beach": {
          "en": "",
          "de": "Traumstrand vor der Haustür."
        }
      }
    }
  ]
}

TIPS

  • Please be aware of the mandatory descriptions you have to send. If omitted, your request will not be handled.
  • Besides, you always have to send all your descriptions even if you only change a part for a specific item. If one description is being omitted, your description will disappear.



Showing descriptions

Method URL Description
GET /service/objects/descriptions/$object_id Show all descriptions for one specific property
GET /service/objects/descriptions/ Show all descriptions for all the properties accessible with your API key

Example response:

{
  "OK": 1,
  "Request": {
    "Method": "GET",
    "Path": "/service/objects/descriptions/1010397"
  },
  "ObjectsDescriptionsServiceResult": [
    {
      "object_id": 1010397,
      "descriptions": {
        "short_description": {
          "en": "",
          "de": "Komfortabel ausgestattete Ferienwohnung ca. 60 qm auf zwei Ebenen. 1 Wohnraum mit großzügigem Essbereich, 1 geschmackvoll und komplett ausgestattete Küche, 2 Schlafräume sowie ein schönes freundliches Bad stehen zur Verfügung. Eigene Terrasse. Wlan"
        },
        "exterior_info": {
          "en": "",
          "de": "Für Ihr Auto steht ein PKW-Stellplatz zur Verfügung. Terrasse mit Gartenmöbeln ist vorhanden."
        },
        "location_info": {
          "en": "",
          "de": "Das im Jahre 1996 erbaute Friesenhaus mit 4 Ferienwohnungen befindet sich in Alt Westerland. Sie gehen nur 15 Minuten bis zum Strand oder zum Freizeitbad Sylter Welleund nur ca. 10 Minuten bis in das Stadtzentrum. Der Bahnhof befindet sich ungefähr 5 Minuten entfernt. Durch seine günstige Lage ist das Haus der ideale Ausgangspunkt für die vielfachen und interresanten Möglichkeiten auf Sylt den Urlaub zu erleben. Direkt an der befahrenen Keitumer-Landstraße gelegen."
        },
        "interior_info": {
          "en": "",
          "de": "Dieses 60 qm große Appartement hat 3 Zimmer über zwei Ebenen EG/UG, einen Wohnraum mit großzügigem Essbereich und eine geschmackvoll und komplett ausgestattete Küche, zwei Schlafräume sowie ein schönes freundliches Bad. Kostenloser WLAN Zugang, Kabel-TV, Radio"
        },
        "additional_info": {
          "en": "",
          "de": "Haustiere sind leider nicht erlaubt. Nichtraucher oder auf der Terrasse"
        },
        "special_features": {
          "en": "",
          "de": "Fußbodenheizung im Badezimmer"
        },
        "price_info": {
          "en": "",
          "de": "Wäschepaket: Bett bezogen 2 Badehandtücher ,2 kleine Handtücher, Duschvorleger und Geschirrtuch pro Person"
        },
        "tenant_info": {
          "en": "",
          "de": "Die Schlüsselübergabe findet bei uuns im Büro in der Musterstr. 25 statt"
        },
        "holiday_category_dog": {
          "en": "",
          "de": "Hunde sind sehr willkommen und können sich hier frei bewegen. Fressnapf und Hundehütte stehen bereit."
        },
        "holiday_category_wintersport": {
          "en": "",
          "de": "Skilift in nur 200m Entfernung."
        },
        "holiday_category_farm": {
          "en": "",
          "de": "Hier gibt es Kühe, Schweine und Gänse. Wir haben Tiere aller Art."
        },
        "holiday_category_lake": {
          "en": "",
          "de": "Hier kann man sich komplett erholen und entspannen"
        },
        "holiday_category_sea": {
          "en": "",
          "de": ""
        },
        "holiday_category_beach": {
          "en": "",
          "de": "Traumstrand vor der Haustür."
        }
      }
    }
  ]
}

TIPS

  • No tips necessary :)



api/services/descriptions.txt · Last modified: 2025/05/22 13:38 by 127.0.0.1

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki