Les champs liés à la « durée » (durée d’une visite, d’une activité, d’un séjour etc…) sont actuellement éclatés dans des endroits différents suivant les types objets.
L’objectif de ce chantier est de simplifier la saisie des durées en regroupant les champs existants. Nous allons profiter de l’occasion pour ouvrir ces champs à de nouveaux types objets.
En API, les champs « durée » seront désormais tous présents dans le nœud ouverture.
En complément, nous ajouterons la possibilité d’effectuer des recherches en API sur des durées min/max des offres.
Description des nouveaux champs
Quatre nouveaux champs seront utilisés à présent :
- ouverture.nombreJours : Integer, ACT, COS, EQU, EVE, PCU, PDT, SEJ
Nombre de jours sur lesquels s’étale l’offre (sur les types)
(Attention, nombreJours > 2 sauf pour le type objet « SEJOURS_PACKAGES » où nombreJours > 1) - ouverture.nombreNuits : Integer, SEJ
Nombre de nuits pour les séjours - ouverture.dureeSeance : Integer (minutes), ACT, EVE, COS, PDT, PCI, EQU, PNA
Durée (de visite, de pratique, de séance …) de l’offre - ouverture.dureeSeanceGroupe : Integer (minutes), EQU, PCU, PDT, PNA
Durée (de visite, de pratique, de séance …) de l’offre pour les groupes
Exemple de payload envoyée pour renseigner ces champs sur une offre :
[...],
"ouverture": {
"periodeEnClair": {},
"periodeEnClairGenerationMode": "AUTOMATIQUE",
"nombreJours" : 3,
"dureeSeance": 121,
"dureeSeanceGroupe": 32
},
[...]Tableau récapitulatif des migrations de champ :
Les valeurs des anciens champs déjà renseignées seront automatiquement reportées dans les nouveaux grâce à un script de migration de données, voir ci-dessous Retro-compatibilité.
| Types objet concernés | Champs dépréciés | Nouveaux champs |
| Activité | informationsActivite.dureeSeance | ouverture.dureeSeance |
| Activité | informationsActivite.nombreJours | ouverture.nombreJours |
| Équipement | informationsEquipement.itineraire.dureeJournaliere | ouverture.dureeSeance |
| Équipement | informationsEquipement.itineraire.dureeItinerance | ouverture.nombreJours |
| Séjour | informationsSejourPackage.nombreJours | ouverture.nombreJours |
| Séjour | informationsSejourPackage.nombreNuits | ouverture.nombreNuits |
| Producteur, Patrimoine Culturel, Équipement, Patrimoine naturel | visites.dureeMoyenneVisiteIndividuelle | ouverture.dureeSeance |
| Producteur, Patrimoine culturel, Équipement, Patrimoine naturel | visites.dureeMoyenneVisiteGroupe | ouverture.dureeSeanceGroupe |
Ajout d’un champ dureeMin / dureeMax pour filtrer les résultats
A l’image de dateMin / dateMax il vous permet de lister les offres à faire en X temps disponible (ajouté le 25/06/2024).
Exemple de requête utilisant ce nouveau filtre :
https://api.apidae-tourisme.com/api/v002/recherche/list-objets-touristiques?query={"projetId":"AAA","apiKey":"BBB","selectionIds":[CCC],"count":10,"responseFields":["nom","informations","ouvertures"],"dureeMin":120,"dureeMax":180}Rétrocompatibilité
Les champs dépréciés ne sont plus accessibles via l’IHM depuis le 25/06/2024 . Pour assurer une transition en douceur, ils resteront disponibles sur les flux API en consultation et en écriture quelques temps.
Une écriture avec les anciens champs viendra mettre à jour les nouveaux automatiquement, et inversement.
Une écriture avec anciens champs + nouveaux champs sera refusée.
Les champs dépréciés seront supprimés fin 2025.