Le multi-horaires est un bloc métier permettant de détailler plus précisément les périodes d’ouvertures d’une offre touristique en spécifiant des tranches horaires.
Est détaillée ici l’utilisation de l’API de lecture liée au Multi-horaire. L’utilisation de cette API nécessite un nouvel appel API pour chaque fiche.
Cette fonctionnalité est portée par le module externe Apidae-Date développé par Hotentic. Ce module est intégré à Apidae, il permet la visualisation et la modification des entrées du multi-horaire.
Vous retrouverez les spécifications de ce module ici.
Au niveau des API, le multi-horaire est utilisable en consultation, mais pas encore en modification.
Afin de faire la jonction entre les périodes contenues dans Apidae et celles stockées dans le module Apidae-Date nous avons ajouté un identifiant technique aux périodes d’ouvertures : identifiantTechnique.
Vous retrouverez le détail des caractéristiques d’une période ouverture ici.
{
"type" : "RESTAURATION",
"ouverture" : {
"periodesOuvertures" : [ {
"identifiant" : 16407540,
"dateDebut" : "2020-01-01",
"dateFin" : "2020-12-01",
"type" : "OUVERTURE_TOUS_LES_JOURS",
"tousLesAns" : true,
"identifiantTechnique" : 20537739
} ]
}
}Via cet identifiantTechnique, il est possible de récupérer toutes les tranches horaires d’une période d’ouverture spécifique.
Les appels API se font ensuite sur l’URL de la brique Multi-horaire :
https://api.apihours.apidae-tourisme.com/apidae_period
Environnements correspondants
base.apidae-tourisme.com : https://api.apihours.apidae-tourisme.com/
base.apidae-tourisme.cooking : https://api.apidate-preprod.apidae.net/
base.apidae-tourisme.dev : https://api.apidate-preprod.apidae.net/
La sélection de la période ou des périodes souhaitées se fait comme suit grâce à la valeur du champ identifiantTechnique.
https://api.apihours.apidae-tourisme.com/apidae_period?id="123456" https://api.apihours.apidae-tourisme.com/apidae_period?ids=["123456", "456789"]
Attention, les identifiantTechnique sont à placer entre guillemets.
Exemple avec l’appel suivant :
https://api.apihours.apidae-tourisme.com/apidae_period?id="20537739"
Attention, les champs startDate et endDate ne sont actuellement pas actualisés après la première saisie : préférez les informations ouverture.periodesOuvertures[].dateDebut et ouverture.periodesOuvertures[].dateFin de l’offre au format JSON.
{
startDate: "2020-01-01", // Attention cette donnée n'est pas fiable : préférez l'information dateDebut de l'offre au format json
endDate: "2020-12-01", // Attention cette donnée n'est pas fiable : préférez l'information dateFin de l'offre au format json
timePeriods: [
{
timeFrames: [
{
recurrence: null,
endTime: "15:00",
startTime: "13:00"
}
],
labels: {
ru: "График обслуживания",
fr: "Horaires de service",
en: "Service schedule",
nl: "Bedieningstijden",
de: "Betriebszeiten",
it: "Orario di esercizio",
pt-br: "Horário de Serviço",
zh: "服务时间表",
es: "Horario de servicio"
},
type: "service",
weekdays: [
"MON",
"TUE",
"WED",
"THU",
"FRI",
"SAT",
"SUN"
]
}
],
externalType: "RESTAURATION",
userId: 14410,
externalRef: 869728,
externalId: 20537739,
updatedAt: 1613743004377,
type: "apidae_period"
}