Détail d'une structure

Ce service web a pour objectif de vous permettre de récupérer l'ensemble des informations détaillées d'une structure spécifique.

GET @api/partners/hotels/@hotel_id

@hotel_id string ID de la structure à interroger

Réponse du service

Le service répond avec un code HTTP 200 OK en cas de réussite du traitement. Vous trouverez ci-dessous un exemple de réponse au format JSON.

Exemple de réponse JSON

  {
    "data": {
      /** @var string Identifiant unique de la structure */
      "id": "H88G015920",
      /** @var string|null Identifiant legacy de la structure */
      "legacy_id": "88G10001",
      /** @var string Identifiant unique de la version de la structure */
      "version": "21c5f838294545fd81aef92796106e92",
      /** @var string Type de la structure */
      "type": "G",
      /** @var object Titre commercial de la structure (avec traductions) */
      "title": {
        "fr": "Hébergement cosy à la montagne"
      },
      /** @var object Nom de la structure (avec traductions) */
      "name": {
        "fr": "le Nid des Oiseaux"
      },
      /** @var int Capacité minimale de la structure */
      "min_capacity": 1,
      /** @var int Capacité maximale de la structure */
      "max_capacity": 9,
      /** @var int|null Étage où est située la structure */
      "floor": null,
      /** @var int|null Superficie totale de la structure */
      "surface": 150,
      /** @var array Liste des catégories associées à la structure */
      "categories": [
        "gite",
        "maison"
      ],
      /** @var object Descriptions textuelles liées à la structure (avec traductions) */
      "descriptions": {
        /** @var object Présentation de la structure (avec traductions) */
        "about": {
          "fr": "En famille ou entre amis, ..."
        },
        /** @var object Présentation complémentaire de la structure (avec traductions) */
        "infos": {
          "fr": "Aménagée sur deux niveaux, maison individuelle spacieuse et lumineuse."
        },
        /** @var object Accès à la structure (avec traductions) */
        "access": {
            "fr": "Aménagée sur deux niveaux, maison individuelle spacieuse et lumineuse."
        },
        /** @var object Aménagements handicaps de la structure (avec traductions) */
        "handicap": {
            "fr": "Aménagée sur deux niveaux, maison individuelle spacieuse et lumineuse."
        },
        /** @var object Disponibilité de la structure (avec traductions) */
        "availabilities": {
          "fr": "Ouvert toute l'année."
        },
        /** @var object Modalités d'accueil de la structure (avec traductions) */
        "welcome": {
          "fr": "Vous serez accueillis sur place par Gaëtan et Lauriane, les propriétaires."
        }
      },
      /** @var object Adresse postale de la structure */
      "address": {
        /** @var string Adresse postale */
        "address1": "2421 Route Devant le Cour",
        /** @var string Complément d'adresse postale */
        "address2": null,
        /** @var string Code postal */
        "zipcode": "88600",
        /** @var string Ville */
        "city": "La Chapelle-devant-Bruyères",
        /** @var string Pays */
        "country": "France",
        /** @var float Longitude */
        "lng": 6.812801,
        /** @var float Latitude */
        "lat": 48.200138,
        /** @var int|null Altitude */
        "alt": 525
        /** @var string|null Code INSEE commune */
        "insee": 88120
      },
      /** @var array Liste des méthodes de paiements supportés sur place */
      "payment_methods": [
        "cb",
        "chq",
      ],
      /** @var array Liste des aménagements handicaps réalisés sur la structure */
      "handicaps": [
        "mot",
        "vis"
      ],
      /** @var bool Les animaux sont acceptés ? */
      "pets_allowed": true,
      /** @var bool Les séjours professionnels sont acceptés ? */
      "pros_allowed": true,
      /** @var string|null Orientation du bien */
      "orientation": null,
      /** @var string|null Numéro d'enregistrement unique */
      "registration_number": null,
      /** @var string|null Site internet de la structure */
      "website": null,
      /** @var string|null URL d'accès à la fiche détaillée de la structure sur Cloudspire */
      "url": "https://www.gites-de-france-loire-atlantique.com/fr/location/locations-gites-chateau-thebaud-le-fief-des-bauches-h44g011742",
      /** @var string URL d'accès à la fiche détaillée de la structure sur Gîtes de France */
      "gdf_sn_url": "https://www.gites-de-france.com/fr/locations/h44g011742',
      /** @var object Coordonnées de la centrale de production de la structure */
      "channel": {
        /** @var string Identifiant unique de la centrale */
        "id": "9e76f0aeebe44b00a3d069ccee354538",
        /** @var string Référence courte de la centrale */
        "reference": "GDF88",
        /** @var string Désignation de la centrale */
        "name": "Gîtes de France Vosges",
        /** @var string Adresse e-mail de la centrale */
        "email": "resa@vosges-gites.com",
        /** @var string Numéro de téléphone de la centrale */
        "phone": "0329353338",
        /** @var object Coordonnées postale de la centrale */
        "address": {
          /** @var string Adresse postale */
          "address1": "1 Rue du Pâquis",
          /** @var string Complément d'adresse postale */
          "address2": null,
          /** @var string Code postal */
          "zipcode": "88000",
          /** @var string Ville */    
          "city": "Épinal",
          /** @var string Pays */ 
          "country": "France"
        }
      },
      /** @var array Liste des photos de la structure */
      "pictures": [
        {
          /** @var int Identifiant unique d'une photo */
          "id": 398520,
          /** @var object Légende de la photo (avec traductions) */
          "caption": {
            "fr" : "Vue sur le lac depuis la salle à manger"
          },
          /** @var int Taille du fichier (en octets) */
          "filesize": 332133,
          /** @var string URL d'accès au fichier */
          "url": "https:\/\/img.sf-ifrit.fr\/rooms\/H88G015920\/H88G015920_5dd3189941c94.jpg"
        }
      ],
      /** @var array Liste des spécificités de la structure */
      "amenities": [
        {
          /** @var int Identifiant unique de la spécificité */
          "amenity_id": 56,
          /** @var int|null Distance (en mètres) avec la spécificité */
          "distance": 1500
        }
      ],
      /** @var array Liste des classements de la structure */
      "ranking": [
        {
          /** @var string Type de classement */ 
          "type": "star",
          /** @var int Valeur du classement */
          "value": 3,
          /** date Date de dernière labellisation connue */
          "ranked_at": "2019-08-19"
        },
      ],
      /** @var array Liste des gestionnaires de la structure */
      "managers": [
        {
          /** @var string Identifiant unique du gestionnaire */
          "id": "420ea9d207a347608b8b6e27a513db02",
          /** @var string Référence unique du compte */
          "reference": "C220000001",
          /** @var string Rôle du gestionnaire */
          "role": "owner",
          /** @var string Nom d'affichage du gestionnaire */
          "nicename": "M. John DOE",
          /** @var string Adresse e-mail de contact du gestionnaire */
          "email": "contact@cloudspire.io",
          /** @var string Numéro de téléphone de contact du gestionnaire */
          "phone_1" : "+33652576584",
          /** @var string Prénom du propriétaire */
          "first_name" : "John",
          /** @var string Nom du propriétaire */
          "last_name" : "DOE",
          /** @var date|null Date de naissance du propriétaire */
          "birthdate" : "2012-05-04",
          /** @var string|null Nom de la société (si applicable) */
          "company_name" : null,
          "address": {
            /** @var string|null Adresse postale du propriétaire */
            "address1": "15 chemin des fleurs",
            /** @var string|null Complément d'adresse postale du propriétaire */
            "address2": "15 chemin des fleurs",
            /** @var string|null Code postal du gestionnaire */
            "zipcode": "88600",
            /** @var string|null Ville du gestionnaire */
            "city": "BRUYERES",
            /** @var string|null Pays du gestionnaire */
            "country": "FRANCE",
          },
          /** @var array|null Liste des langues parlées par le gestionnaire */
          "spoken_languages": [
            "fr"
          ]
        }
      ],
      /** @var array Liste des zones de location de la structure */
      "rooms": [
        {
          /** @var string Identifiant unique de la zone */
          "id": "H88G015920",
          /** @var string Identifiant unique de la version de la zone */
          "version": "21c5f838294545fd81aef92796106e92",
          /** @var string Nom de la zone de location */
          "name": {
            "fr": "le Nid des Oiseaux"
          },
          /** @var int Capacité minimale de la zone */
          "min_capacity": 1,
          /** @var int Capacité maximale de la zone */
          "max_capacity": 9,
          /** @var int Étage où se situe la zone */
          "floor": null,
          /** @var int Surface totale de la zone */
          "surface": 150,
          /** @var int Nombre de salles de bain de la zone */
          "bathrooms": 1,
          /** @var int Nombre de chambres de la zone */
          "bedrooms": 4,
          /** @var int Nombre de lits de la zone */
          "beds": 6,
          /** @var int Nombre de salles d'eau de la zone */
          "waterrooms": 1,
          /** @var object Liste des description de la zone */
          "descriptions": {
            /** @var object Présentation de la zone (avec traductions) */
            "about": {
              "fr": "En famille ou entre amis, ..."
            },
            /** @var object Présentation complémentaire de la zone (avec traductions) */
            "infos": {
              "fr": "Aménagée sur deux niveaux, maison individuelle spacieuse et lumineuse."
            },
            /** @var object Accès à la zone (avec traductions) */
            "access": {
                "fr": "Aménagée sur deux niveaux, maison individuelle spacieuse et lumineuse."
            },
            /** @var object Aménagements handicaps de la zone (avec traductions) */
            "handicap": {
                "fr": "Aménagée sur deux niveaux, maison individuelle spacieuse et lumineuse."
            },
            /** @var object Disponibilité de la zone (avec traductions) */
            "availabilities": {
              "fr": "Ouvert toute l'année."
            },
            /** @var object Modalités d'accueil de la zone (avec traductions) */
            "welcome": {
              "fr": "Vous serez accueillis sur place par Gaëtan et Lauriane, les propriétaires."
            }
          },
          /** @var array Liste des spécificités de la structure */
          "amenities": [
            {
              /** @var int Identifiant unique de la spécificité */
              "amenity_id": 56,
              /** @var int|null Distance (en mètres) avec la spécificité */
              "distance": 1500
            }
          ],
          /** @var array Liste des pièces de la zone */
          "spaces": [
            {
              /** @var object Désignation de la pièce (avec traductions) */
              "name": {
                "fr": "Séjour-cuisine"
              },
              /** @var object Description de la pièce (avec traductions) */
              "about": {
                "fr": "Cuisine intégrée toute équipée ouverte sur séjour\/salon."
              },
              /** @var int|null Superficie de la pièce */
              "surface": 70,
              /** @var int|null Étage où se situe la pièce */
              "floor": 0,
              "beds": {
                /** @var int|null Nombre de lits 80x190 */
                "80x190" null
                /** @var int|null Nombre de lits, 80x200 */
                "80x200" null
                /** @var int|null Nombre de lits, 90x190 */
                "90x190" null
                /** @var int|null Nombre de lits, 90x200 */
                "90x200" null,
                /** @var int|null Nombre de lits 100x200 */
                "100x200" null
                /** @var int|null Nombre de lits, 120x190 */
                "120x190" null
                /** @var int|null Nombre de lits, 140x190 */
                "140x190" null
                /** @var int|null Nombre de lits, 160x200 */
                "160x200" null
                /** @var int|null Nombre de lits, 180x200 */
                "180x200" null
                /** @var int|null Nombre de lits, 200x200 */
                "200x200" null,
                /** @var int|null Nombre de lits superposés (déjà inclus parmis le total des lits) */
                "included_bunk" null
                /** @var int|null Nombre de lits jumelés (déjà inclus parmis le total des lits) */
                "included_twin" null,
                /** @var int|null Nombre de lits gigognes (déjà inclus parmis le total des lits) */
                "included_trundle" null,
              },
              /**
               * @var int|null Nombre de lits 80x190
               * @deprecated Utiliser beds.80x190
               */
              "beds_80": null,
              /**
               * @var int|null Nombre de lits 90x190 
               * @deprecated Utiliser beds.90x190
               */ 
              "beds_90": null,
              /**
               * @var int|null Nombre de lits 120x200
               * @deprecated Utiliser beds.120x190
               */
              "beds_120": null,
              /**
               * @var int|null Nombre de lits 140x200
               * @deprecated Utiliser beds.140x190
               */
              "beds_140": null,
              /**
               * @var int|null Nombre de lits 160x200
               * @deprecated Utiliser beds.160x200
               */
              "beds_160": null,
              /**
               * @var int|null Nombre de lits 180x200
               * @deprecated Utiliser beds.180x200
               */
              "beds_180": null,
              /**
               * @var int|null Nombre de lits superposés
               * @deprecated Utiliser beds.included_bunk ; Attention, le champ beds.included_bunk n’est plus un compte séparé, mais inclus dans le total des lits.
               */
              "beds_overlayed": null,
              /** @var object Vue de la pièce (avec traductions) */
              "view": {
                "fr" : "Vue sur la vallée"
              }
            }
          ],
          /** @var object Classement de la zone */
          "ranking": [
            {
              /** @var string Type du classement */
              "type": "star",
              /** @var int Valeur du classement */
              "value": 3,
              /** date Date de dernière labellisation connue */
              "ranked_at": "2019-08-19"
            }
          ],
          /** @var array Liste des photos de la zone */
          "pictures": [
            {
              /** @var int Identifiant unique de la photo */
              "id": 398520,
              /** @var object Légende de la photo (avec traductions) */
              "caption": {
                "fr" : "Vue de la cuisine sur la forêt"
              },
              /** @var int Poids du fichier (en octets) */
              "filesize": 332133,
              /** @var string URL du fichier image*/
              "url": "https:\/\/img.sf-ifrit.fr\/rooms\/H88G015920\/H88G015920_5dd3189941c94.jpg"
            }
          ],
          /** @var array Liste des services additionnels proposés par la zone */
          "additionnals_services": [
            {
              /** @var string Identifiant unique du service */
              "id": "0",
              /** @var string Type de service */
              "type": "cleaning",
              /** @var object Désignation du service (avec traductions) */
              "name": {
                "fr": "Location linge de toilette"
              },
              /** @var object Description du service (avec traductions) */
              "about": {},
              /** @var string Service proposé aux séjours professionnels, particuliers ou les deux */
              "available_for": "all",
              /**
               * @var string Service requis ?
               * @deprecated Utiliser required_for
               */
              "required": "not",
              /** @var string Service requis pour la réservation */
              "required_for": "none",
              /**
               * @var string Stratégie de facturation du service
               * @deprecated Utiliser amount_strategy
               */
              "strategy": "pppt",
              /** @var string Stratégie de facturation du service */
              "amount_strategy": "per_person_per_trip",
              /** @var float Montant unitaire du service */
              "amount": 8,
              /** @var string|null Jours de disponibilité du service */
              "available_days": "1110001",
              /** @var int max_quantity Quantité maximale de service (seulement si strategy = free_quantity) */
              "max_quantity": 1,
              /** @var bool payable_on_spot Le service est-il payant sur place ? */
              "payable_on_spot": false,
              /** @var bool is_restricted_by_periods Le service est-il restreint par périodes ? */
              "is_restricted_by_periods": false,
              /** @var array Liste des périodes de restriction du service (si is_restricted_by_periods = true) */
              "periods": [{
                "start_day": 1,
                "start_month": 7,
                "end_day": 31,
                "end_month": 7
              }]
            }
          ],
          /** @var object Liste des configurations de réservation */
          "booking_settings": {
            /** @var string Formule de commercialisation de la zone */
            "room_management": "shared",
          },
          /** @var int|null Montant de la caution exigée sur la zone */
          "guarantee": 600,
          /** @var int|null Montant du supplément de caution si animaux présents */
          "pets_extra_guarantee": null,
          /** @var datetime Date de création de la zone */
          "created_at": "2019-08-12T22:25:01+0200",
          /** @var datetime Date de dernière mise à jour des contenus de la zone */
          "content_updated_at": "2020-02-19T14:46:56+0100",
          /** @var datetime Date de dernière mise à jour des tarifs/dispos de la zone */
          "pricing_updated_at": "2020-06-08T06:00:00+0200"
        }
      ],
      /** @var array Liste des tarifs à partir de de la structure */
      "pricings" : {
        /** @var float|null Montant du séjour le moins cher à venir sur les 540 prochains jours */
        "min_trip_amount" : 1000.00,
        /** @var float|null Montant de la nuit la moins chère à venir sur les 540 prochains jours */
        "min_trip_amount_per_night" : "15.75"
      },
      /** @var datetime Date d'ouverture de la structure */
      "opened_since": "2003-08-12",
      /** @var datetime|null Date de radiation de la structure */
      "closed_since": "2003-08-12",
      /** @var datetime Date de création de la structure */
      "created_at": "2019-08-12T22:25:01+0200",
      /** @var datetime Date de dernière mise à jour des contenus de la structure */
      "content_updated_at": "2020-02-19T14:46:56+0100",
      /** @var datetime Date de dernière mise à jour des tarifs/dispos de la structure */
      "pricing_updated_at": "2020-06-08T06:00:00+0200"
    },
    "meta": []
  }

Informations détaillées de la réponse

type (string)

Cet attribut représente le type de la structure. Cet attribut autorise les valeurs suivantes :

Valeur	Description
G	Gîte
H	Maison d'hôtes
C	Camping
E	Gîte d'étape
P	Gîte de groupe

categories (string)

Cet attribut représente la liste des catégories des biens. Cet attribut autorise les valeurs suivantes :

Valeur	Description
gite	Gîte
hote	Maison d'hôtes
city_break	City break
camping	Camping
chalet	Châlet
chalet-loisirs	Châlet loisirs
chateau	Château
ferme	Ferme
maison	Maison
groupe	Gîte de groupe
villa	Villa
appartement	Appartement
ecogite	Éco-gîte
haut-gamme	Haut de gamme
gite-enfant	Gîte d'enfants
fuste	Fuste
bungalow	Bungalow
moulin	Moulin
hote-ferme	Hôtel Ferme
camping-ferme	Camping ferme
gourmande-ferme	Gourmande ferme
gourmande-locaux	Gourmande locaux
auberge-familiale	Auberge familliale
ferme-pedagogique	Ferme pédagogique
mobil-home	Mobil-home
camping-mobil-home	Camping Mobil'Home

payment_methods : array(string)

Cet attribut représente la liste des moyens de paiement supportés par la structure. Cet attribut autorise les valeurs suivantes :

Valeur	Description
cb	Carte bancaire
chq	Chèque
vir	Virement
esp	Espèces
kdo	Chèques KDO
ancv	Chèques ANCV
paypal	Paypal

handicaps : array(string)

Cet attribut représente la liste des aménagements face aux handicaps de la structure. Cet attribut autorise les valeurs suivantes :

Valeur	Description
men	Mental
mot	Moteur
vis	Visuel
aud	Auditif

orientation : (string)

Cet attribut représente l'orientation géographique de la structure. Cet attribut autorise les valeurs suivantes :

Valeur	Description
n	Nord
s	Sud
e	Est
w	West
ne	Nord-Est
no	Nord-Ouest
se	Sud-Est
so	Sud-Ouest

ranking.type : (string)

Valeur	Description
epi	Épis Gîtes de France
star	Étoiles

rooms.additionnals_services.type : (string)

Valeur	Description
double_bed_linen	Linge de lit double
single_bed_linen	Linge de lit simple
complete_bed_linen	Linge de lit complet
house_linen	Linge de maison
bathroom_linen	Linge de toilette
complete_linen	Kit linge complet
cleaning	Ménage de fin de séjour
room_rental	Location de salle
pets	Supplément animaux
firewood	Bois de chauffage
heating_package	Forfait chauffage
extra_person	Personne supplémentaire
guest_table	Table d’hôte
other	Autre

rooms.additionnals_services.available_for : (string)

Valeur	Description
professional	Disponible pour les séjours professionnels
particular	Disponible pour les séjours particuliers
all	Disponible pour tous les séjours

rooms.additionnals_services.required : (string)

⚠️ Attention, ce champ ne doit plus être utilisé. Utilisez le champ required_for à la place.

Valeur	Description
not	Facultatif
all	Obligatoire
pro	Obligatoire pour les séjours professionnels

rooms.additionnals_services.required_for : (string)

Valeur	Description
none	Optionnel
all	Obligatoire tous les séjours
professional	Obligatoire pour les séjours professionnels
par	Obligatoire pour les séjours particuliers

⚠️ La valeur par est obsolète et ne sera plus envoyée.

rooms.additionnals_services.strategy : (string)

⚠️ Attention, ce champ ne doit plus être utilisé. Utilisez le champ amount_strategy à la place.

Valeur	Description
papn	Tarif par adulte, par nuit
papd	Tarif par adulte, par journée
papt	Tarif par adulte, par séjour
pn	Tarif par nuit, par séjour
pd	Tarif par journée, par séjour
pt	Tarif par séjour
pppn	Tarif par personne, par nuit
pppd	Tarif par personne, par journée
pppt	Tarif par personne, par séjour
pepn	Tarif par animal, par nuit
pepd	Tarif par animal, par journée
pept	Tarif par animal, par séjour
pb1ppn	Tarif par lit 1 pers., par nuit
pb1ppd	Tarif par lit 1 pers., par journée
pb1ppt	Tarif par lit 1 pers., par séjour
pb2ppn	Tarif par lit 2 pers., par nuit
pb2ppd	Tarif par lit 2 pers., par journée
pb2ppt	Tarif par lit 2 pers., par séjour

rooms.additionnals_services.amount_strategy : (string)

Valeur	Description
per_adult_per_night	Tarif par adulte, par nuit
per_adult_per_day	Tarif par adulte, par journée
per_adult_per_trip	Tarif par adulte, par séjour
per_person_per_night	Tarif par personne, par nuit
per_person_per_day	Tarif par personne, par journée
per_person_per_trip	Tarif par personne, par séjour
per_night	Tarif par nuit, par séjour
per_day	Tarif par journée, par séjour
per_trip	Tarif par séjour
per_pet_per_night	Tarif par animal, par nuit
per_pet_per_day	Tarif par animal, par journée
per_pet_per_trip	Tarif par animal, par séjour
per_single_bed_per_night	Tarif par lit simple, par nuit
per_single_bed_per_day	Tarif par lit simple, par journée
per_single_bed_per_trip	Tarif par lit simple, par séjour
per_double_bed_per_night	Tarif par lit double, par nuit
per_double_bed_per_day	Tarif par lit double, par journée
per_double_bed_per_trip	Tarif par lit double, par séjour
free_quantity	Quantité libre

rooms.additionnals_services.available_days : (string|null)

Correspond aux jours de disponibilité du service sur 6 chiffres (commençant le dimanche et finissant le semadi). 1 signifie que le jour est disponible, 0 signifie qu'il ne l'est pas.

Si le champ vaut null, alors l'option est disponible tous les jours. La valeur "0000000" ne peut pas exister.

Exemple :

• null : le service est disponible tous les jours
• "1000001" : le service est disponible du samedi au dimanche
• "0111110" : le service est disponible du lundi au vendredi
• "0111001" : le service est disponible du lundi au mercredi et le samedi

On considère que le service peut être souscrit si au moins 1 jour de la réservation est dans la période de disponibilité (jour de sortie exclu).

rooms.additionnals_services.periods.* : (array)

Correspond à une période de restriction du service.

Valeur	Description
start_day	Jour de début de la période
start_month	Mois de début de la période
end_day	Jour de fin de la période
end_month	Mois de fin de la période

bookings.booking_settings : (string)

Valeur	Description
exclusive	Planning exclusif
shared	Planning partagé
direct	planning en location directe

managers.role : (string)

Valeur	Description
owner	Propriétaire de la structure
representative	Mandataire de la structure

state : (string)

Valeur	Description
en	Structure activée (disponible à la distribution)
di	Structure désactivée (indisponible à la distribution)

Gestion des erreurs

Code HTTP	Raison
400	Erreur(s) de validation des données
401	Aucun jeton de sécurité communiqué
403	Vous n'avez pas/plus accès à la structure spécifiée
404	La structure demandée n'est pas/plus disponible
500	Erreur interne de traitement des données