Documentation technique

Liens entre objets touristiques (v1)

Plusieurs champs permettent aux utilisateurs de la base Apidae de lier leurs objets touristiques entre eux. Lier plusieurs événements d’un festival, des activités avec un prestataire, des objets sur un territoire (géographique ou thématique). Toutes ces informations sont disponibles.
Et n’oubliez pas que vous pouvez aussi utiliser les recherches (géographique géolocalisée, par commune, par critères) pour proposer une navigation aisée et pertinente entre les objets touristiques.

Formats utilisés

Les liens vers les objets touristiques font l’objet d’un traitement particulier. De manière à contrôler la taille des flux, les informations relatives aux objets liés présentes à l’intérieur d’un objet touristique sont présentées dans un format particulier qui diffère selon le mode d’exploitation (API ou exports).

Ce paragraphe détaille les informations directement accessibles dans les flux.

API

Un format condensé pour contrôler la taille du flux

Le format des objets liés est modifié et simplifié par rapport au format complet.

La liste des champs fournis est la suivante : id, nom, identifierSitra1, state, adresse, geolocalisation. Les champs adresse et geolocalisation correspond respectivement aux champs localisation.adresse et localisation.geolocalisation de l’objet complet.

Si des informations vous font défaut, réalisez d’autres requêtes avec les identifiants fournis pour récupérer l’ensemble des informations nécessaires.

{
        "type" : "COMMERCE_ET_SERVICE",
        "id" : 172424,
        "nom" : {
          "libelleFr" : "Club des PIOU PIOU"
        },
        "identifierSitra1" : "sitraCOS706268",
        "adresse" : {
          "adresse1" : "Au Chinaillon ou au sommet de la télécabine du Rosay",
          "adresse3" : "Domaine skiable alpin",
          "codePostal" : "74450",
          "commune" : {
            "id" : 30713,
            "code" : "74136",
            "nom" : "Le Grand-Bornand",
            "pays" : {
              "elementReferenceType" : "Pays",
              "id" : 532,
              "libelleFr" : "France",
              "ordre" : 78
            },
            "codePostal" : "74450"
          }
        },
        "geolocalisation" : {
          "altitude" : 1366,
          "complement" : {
            "libelleFr" : "Au sommet de la télécabine du Rosay.nA l'Espace Débutant des Gettiers au Chinaillon"
          },
          "valide" : true,
          "geoJson" : {
            "type" : "Point",
            "coordinates" : [ 6.450573, 45.949113 ]
          }
        }
      }
Exports

Seul le type et l’identifiant

Les objets liés (entiers) font partis du contenu de l’export. Utilisez les couples identifiant / type pour récupérer les informations des objets liés.

{
        "type" : "COMMERCE_ET_SERVICE",
        "id" : 172424
}

Prestataire d’activité

Le champ informationsActivite.prestataireActivites est un champ spécifique aux objets de type ACTIVITE. C’est un champ qui permet d’identifier le prestataire associé à une activité. Cela peut par exemple permettre de réaliser des listes de prestataires d’activité, ou sur une fiche activité d’identifier les activités proposées par le même prestataire.

Il est possible lors de la saisie, quand cela est nécessaire, de surcharger les champs pour l’aspect PRESTATAIRE_ACTIVITES. Les aspects ne sont pas supportés dans les formats v1. Il est nécessaire d’utiliser les formats v2 pour accéder à ces données.

Objets liés

Les types de liens sont les suivants (et sont amenés à évoluer, veillez à prévoir un traitement pour les types de liens que vous ne connaissez pas) :

  • DEFAUT : pas d’information sur le type de lien
  • SUR_PLACE : sur place, indique une réelle proximité entre les objets (pour des objets juste proche l’un de l’autre, la recherche géographique suffit)
  • ADRESSE_UTILE (non bidirectionnel automatique) : adresse utile, par exemple un loueur de matériel pour un parcours de via-ferrata
  • ORGANISATEUR_PROGRAMME : l’objet touristique qui possède le lien est l’organisateur
    exemple un festival -> liensObjetsTouristiquesTypes type = ORGANISATEUR_PROGRAMME -> un événement
  • PROGRAMME_ORGANISATEUR : la réciproque du lien précédent
    événement -> liensObjetsTouristiquesTypes type = PROGRAMME_ORGANISATEUR -> le festival
  • CADRE_OFFRE_SPECIALE : lien vers un objet qui propose une offre spéciale liée à l’objet qui porte le lien
  • OFFRE_SPECIALE_CADRE : la réciproque ; lien vers une offre pour lequel l’objet qui porte le lien propose une offre spéciale
  • PACKAGE_OBJET : lien vers une offre qui fait parti du package proposé par l’objet qui porte le lien
  • OBJET_PACKAGE : lien réciproque ; lien d’un item d’un package vers le package correspondant
  • AU_DEPART_DE (non bidirectionnel automatique) : l’objet se situe au départ de l’objet lié
  • A_L_ARRIVEE_DE (non bidirectionnel automatique) : l’objet se situe à l’arrivée de l’objet lié
  • SUR_LE_PARCOURS_DE (non bidirectionnel automatique) : l’objet se situe sur le parcours de l’objet lié
  • PARCOURS_ETAPE : l’objet lié est une étape de l’objet qui porte le lien
  • ETAPE_PARCOURS : l’objet lié est le parcours correspondant à l’étape qui porte le lien

Concernant les liens dont le sens est important, de manière générale, le terme à gauche s’applique à l’objet qui porte le lien. Exemple festival -> liensObjetTouristiquesTypes -> ORGANISATEUR_PROGRAMME -> pièce de théâtre. L’oganisateur est le festival ; la pièce de théâtre fait partie du programme.

Tous les liens, exceptés ceux notés « non bidirectionnel automatique », sont mis à jour de manière automatique des deux côtés de la relation lors de la mise à jour de la fiche (par exemple, si un lien SUR_PLACE est ajouté à un objet, alors le lien contraposé sera mis en place sur l’objet lié).

Le choix du type est libre lors de la saisie, et tous les types ne possèdent pas le même intérêt ; nous vous conseillons donc de vous rapprocher de votre client pour vérifier quels sont les types de relation qui les intéressent et les modalités d’affichage qu’il désire mettre en place.

Cette liste est ordonnable lors de la saisie. Sur Apidae, vous pouvez visualiser ces relations sur la fiche objet touristique (onglet Multimédias et suggestions) dans un mode simple (listing pur avec un ordre conforme à la saisie – pas de regroupement).

API
{
    "liensObjetsTouristiquesTypes" : [ {
      "type" : "SUR_PLACE",
      "objetTouristique" : {
        "type" : "RESTAURATION",
        "id" : 138443,
        "nom" : {
          "libelleFr" : "Estrade"
        },
        "identifierSitra1" : "sitraRES535584",
        "state" : "PUBLISHED",
        "adresse" : {
          "adresse1" : "1 avenue de Marlioz",
          "codePostal" : "73100",
          "commune" : {
            "id" : 30248,
            "code" : "73008",
            "nom" : "Aix-les-Bains",
            "pays" : {
              "elementReferenceType" : "Pays",
              "id" : 532,
              "libelleFr" : "France",
              "ordre" : 78
            },
            "codePostal" : "73100"
          }
        },
        "geolocalisation" : {
          "reperePlan" : "I5",
          "complement" : {
            "libelleFr" : "à proximité Centre des Congrès"
          },
          "valide" : true,
          "geoJson" : {
            "type" : "Point",
            "coordinates" : [ 5.913488, 45.685954 ]
          }
        }
      }
    }, {
      "type" : "ADRESSE_UTILE",
      "objetTouristique" : {
        "type" : "PATRIMOINE_CULTUREL",
        "id" : 274951,
        "nom" : {
          "libelleFr" : "Parc des thermes"
        },
        "identifierSitra1" : "sitraPCU859226",
        "state" : "PUBLISHED",
        "adresse" : {
          "codePostal" : "73100",
          "commune" : {
            "id" : 30248,
            "code" : "73008",
            "nom" : "Aix-les-Bains",
            "pays" : {
              "elementReferenceType" : "Pays",
              "id" : 532,
              "libelleFr" : "France",
              "ordre" : 78
            },
            "codePostal" : "73100"
          }
        },
        "geolocalisation" : {
          "valide" : true,
          "geoJson" : {
            "type" : "Point",
            "coordinates" : [ 5.915022, 45.686816 ]
          }
        }
      }
    } ]
  }
Exports
{
    "liensObjetsTouristiquesTypes" : [ {
      "type" : "SUR_PLACE",
      "objetTouristique" : {
        "type" : "RESTAURATION",
        "id" : 138443
      }
    }, {
      "type" : "ADRESSE_UTILE",
      "objetTouristique" : {
        "type" : "PATRIMOINE_CULTUREL",
        "id" : 274951
      }
    }

Les territoires

Le champ territoires liste l’ensemble des territoires concernés par l’objet. Ces territoires sont soit décernés de manière automatique en fonction du périmètre géographique de l’objet et des territoires de la base (une commune en commun = territoire affecté à l’objet), soit attribués de manière manuelle à la saisie par les utilisateurs

Le nombre d’éléments à afficher dans le champ territoires étant élevé, un format plus compact est exploité. Dans les flux API, seuls les champs id, nom, type, identifierSitra1 et state sont inclus dans le flux. Il est possible de faire des requêtes supplémentaires avec les identifiants pour obtenir l’intégralité des informations

De manière générale, l’intérêt des territoires variant en fonction de la communication adoptée, cette information ne doit pas être utilisée de manière brute. Il peut par exemple être nécessaire de déterminer avec votre client son intérêt vis à vis des territoires (recherche seulement, affichage, navigation), et déterminer une liste des territoires à mettre en valeur.