Récupérer les disponibilités d'une zone
Ce service web récupère la liste des saisonnalités d'une zone locative.
GET @api/partners/hotels/@hotel_id/rooms/@room_id/availabilities
hotel_id (string) requis : Identifiant unique de l'hôtel à interroger
room_id (string) requis : Identifiant unique de la zone de location à interroger
from (date) requis : Date à partir de laquelle récupérer les disponibilités
to (date) requis : Date maximale à partir laquelle récupérer les disponibilités
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 Statut de la période concernée */
"state": "av",
/** @var date Date de début de la période (inclus) */
"from": "2020-05-15",
/** @var date Date de fin de la période (inclus) */
"to": "2020-08-07"
}
],
"meta": []
}
Dates & durée maximum de récupération des disponibilités
Cet endpoint autorise une recherche d'une durée maximale de 540 jours de disponibilités dans le futur, et un maximum de 1095 jours dans le passé. Les dates spécifiées sur ce service web sont représentées via des intervalles fermés (mathématiquement : [from, to])
Représentation des indisponibilités
Cet endpoint ne retourne que des périodes de disponibilités. Toute période, réputée incluse dans l'intervalle (from, to), mais absente de la réponse doit être considérée comme indisponible.
Informations détaillées de la réponse
state (string)
| Valeur | Description |
|---|---|
| av | Période disponible |
| bo | Période réservée par Cloudspire |
| cl | Période réservée (partenaire/propriétaire) |
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 |