Liste des structures

Ce service web récupère la liste des structures publiées sur votre accès partenaire.

GET @api/partners/hotels

- state array<state> : Statut des structures à récupérer
- channel_id array<string> : Filtrer sur une liste de canaux de distribution
- type array<type> : Types des structures à récupérer
- with_content_updated_since string<datetime> : Filtrer sur la date de dernière MàJ des contenus
- with_pricing_updated_since string<datetime> : Filtrer sur la date de dernière MàJ des tarifs/dispos

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": "H88G000001",
        /** @var string Numéro unique de version de la structure */
        "version": "fcf18c4b26c94e5b9fd2bc5ce5ba12fc",
        /** @var string Statut de la structure (Voir ci-après) */
        "state": "en",
        /** @var string Type de la structure (Gîte, Maison d'hôtes, ...)
        "type": "G",
        /** @var object Nom de la structure (avec traductions) */
        "name": {
          "fr": "Gîte au pied des montagnes"
        },
        /** @var array Liste des zones locatives actives rattachées à cette structure */
        "room_id" : [
          "H88G000001"
        ],
        /** @var int Capacité maximale de l'hôtel */
        "max_capacity": 8,
        /** @var string Identifiant du canal de distribution principal associé à la structure */
        "channel_id": "d1048b5a4eba4a078386daf35d68e987",
        /** @var datetime Date de création de la structure sur Cloudspire */
        "created_at": "2019-09-21T23:10:34+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": {
      /** @var int Nombre de structures présentes dans la réponse */
      "count": 1
    }
  }

Synchroniser uniquement les structures modifiées

Afin d'éviter de synchroniser des fiches structures qui n'auraient pas été mise à jour, vous pouvez vous baser sur l'attribut updated_at pour vérifier si la fiche structure a été modifiée depuis votre dernière requête.

Informations détaillées de la réponse

state (string)

Par défaut, seules les structures activées (en) sont retournées. Les structures désactivées (di) ou supprimées (tr) ne sont récupérables qu'en les demandant explicitement via le filtre state. L'accès aux structures supprimées (tr) est réservé aux partenaires autorisés.

Valeur	Description	Filtre requis
en	Structure activée (disponible à la distribution)	Non
di	Structure désactivée (indisponible à la distribution)	Oui
tr	Structure supprimée (indisponible à la distribution)	Oui

Exemple de requête: récupérer les structures désactivées et supprimées

GET @api/partners/hotels?state[]=di&state[]=tr

type (string)

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

Gestion des erreurs

Code HTTP	Raison
400	Erreur(s) de validation des données
403	Identifiant/mot de passe incorrect
403	Compte partenaire désactivé (voir avec Cloudspire)
403	Accès aux structures supprimées non autorisé pour ce compte
500	Erreur interne de traitement des données