Récupérer les avis clients

Ce service web récupère la liste des avis clients associés à la zone locative passée en paramètre

GET @api/partners/hotels/@hotel_id/rooms/@room_id/comments

- from (date) requis : Récupération des avis clients avec une date de début de séjour supérieure au paramètre
- to (date) requis : Récupération des avis clients avec une date de début de séjour inférieure au paramètre

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 int Identifiant unique d'une réservation */
  		"id": "A180050617",
        /** @var string Type de contrat (+ d'infos ci-dessous) */
        "workflow": "system",
        /** @var string Référence de la structure */
  		"hotel_id": "H88G000200",
        /** @var string Référence de la zone locative */
  		"room_id": "H88G000200",
  		/** @var int|null Référence unique de la réservation associée */
  		"booking_id": 192020,
  		/** @var string Nature du séjour (+ d'infos ci-dessous) */
        "nature": "par",
        /** @var string Statut de l'avis client (+ d'infos ci-dessous) */
  		"state": "published",
        /** @var date Date d'entrée en location */
  		"checkin": "2020-09-11",
        /** @var date Date de sortie de location */
  		"checkout": "2020-09-19",
        /** @var int Nombre d'adultes */
  		"adults": 2,
        /** @var int Nombre d'enfants */
  		"children": 0,
        /** @var int Nombre d'animaux */
  		"pets": 0,
  		/** @var object Informations sur le voyageur */
  		"main_guest": {
            /** @var string Nom d'affichage du voyageur */
  			"display_name": "Benoit FORESTER",
  		},
        /** @var object Liste des notes de l'avis client (voir détail notation ci-dessous) */
        "rates": {
            /** @var int Note moyenne du séjour */
            "average" : 5,
            /** @var int Propreté de l'hébergement */
            "fairness" : 4,
            /** @var int Accueil du propriétaire */
            "greeting" : 3,
            /** @var int Rapport qualité/prix */
            "quality" : 2,
            /** @var int Confort de l'hébergement */
            "cosiness" : 1,
            /** @var Lieu/localisation de l'hébergement */
            "location" : 0,
        },
         /** @var object Titre de l'avis client (avec traductions) */
        "title": {
          "fr": "Très bon séjour"
        },
        /** @var object Contenu de l'avis client (avec traductions) */
        "content": {
          "fr": "Excellent séjour, propriétaire très sympathique."
        },
        /** @var boolean Le voyageur recommande l'hébergement ? */
        "recommendation": true,
        "answers": {
            /** @var object|null Réponse du propriétaire (avec traductions) */
            "owner": {
                "fr": "Merci beaucoup. Au plaisir"
            }
            /** @var object|null Réponse de la centrale de réservation (avec traductions) */
            "system": {
                "fr": "Merci beaucoup."
            }
        },
  		/** @var datetime Date de création de l'avis client */
        "created_at": "2019-08-12T22:25:01+0200",
        /** @var datetime Date de mise à jour de l'avis client */
        "updated_at": "2019-08-13T21:23:04+0200",
        /** @var datetime Date de publication de l'avis client */
        "published_at": "2019-08-15T18:24:02+0200",
  	}],
  	"meta": {
        /** @var int Nombre d'avis clients */
  		"count": 1
  	}
  }

Informations détaillées de la réponse

workflow (string)

Cet attribut représente le type de contrat du séjour lié à l'avis client.

Valeur	Description
system	Contrat centrale
direct	Contrat location directe
partner	Contrat partenaire

state (string)

Cet attribut représente le statut courant de l'avis client.

Valeur	Description
published	Avis client publié

nature (string)

Cet attribut représente la nature du séjour lié à l'avis client.

Valeur	Description
pro	Séjour professionnel
par	Séjour particulier

rates (object)

La notation est une valeur entière comprise entre 1 (note la moins favorable) et 5 (note la plus favorable). La notation 0 est utilisée pour indiquer qu'un voyageur n'a pas souhaité s'exprimer sur le critère concerné.

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)
500	Erreur interne de traitement des données