Documentation technique

Liens avec les entités (v1)

Des champs fournissent des informations administratives sur les objets, et les lient en particulier aux entités juridiques. De manière générale, les informations touristiques nécessaires à la promotion sont disponibles sur la fiche de l’objet lui-même.
Toutefois, en fonction des besoins de votre client, il peut être nécessaire de récupérer de même les informations sur les objets liés. Cette page décrit des éléments.

N’oubliez pas d’échanger avec votre client sur la manière de traiter ces informations. En effet, les informations associées aux entités juridiques sont de manière générale privées, et les informations nécessaires à la promotion sont normalement déjà présentes dans les moyens de communication, de réservation ou les contacts associés à l’objet.

Formats utilisés

Les formats utilisés sont les mêmes que pour les liens entre objets touristiques.

Entité de gestion, entité d’information

Les entités de gestion et d’information sont des notions administratives permettant de lier un objet touristique à une ou deux entités juridiques, appelées respectivement entité de gestion et entité d’information.
Ces informations sont stockées dans les champs informations.structureGestion et informations.structureInformation.

Exemple d’utilisation de l’entité de gestion : sur un meublé, identité du propriétaire du meublé. Ce champ peut permettre de retrouver les différents meublés proposés par un même propriétaire.

Exemple d’utilisation de l’entité d’information : sur un événement festif, l’Office de Tourisme qui n’organise pas mais qui supervise la promotion de l’événement.

Ces informations sont facultatives.

De manière générale, les entités de gestion ne doivent pas être mises en avant. Les informations qui sont importantes (moyens de communication, réservation) sont toutes présentes sur la fiche de l’objet touristique.
Ces informations peuvent néanmoins être intéressantes pour des fonctionnalités avancées (centrale de réservation pour les propriétaires de meublés par exemple).

Si un objet ne possède pas d’entité d’information déterminée (champ vide ou absent), il faut considérer l’entité de gestion comme une entité d’information.

Entité de réservation

Le champ reservation.organismes fourni une liste d’informations relatives à la réservation. Ces informations sont constituées d’un nom (repris de l’objet lié si présent), d’un type (Directe ou Centrale), d’un champ de commentaire observation (traduisible) et d’une liste de moyens de communication (moyensCommunication).

Ces informations sont suffisantes pour réaliser les affichages. Toutefois un dernier champ structureReference permet d’identifier si l’organisme de réservation est issu d’un objet STRUCTURE de la base Apidae. Si le champ structureReference est absent ou vide, alors l’organisme n’est pas lié à une entité.

Comme pour l’entité de gestion, il n’est a priori pas nécessaire de récupérer les informations de l’entité liée, les champs présents sur l’organisme étant normalement suffisant pour l’affichage. Cependant, des besoins avancés (centrale de réservation, …) peuvent rendre nécessaire la récupération de l’entité liée.

API

Format d’un organisme de réservation (cas de l’organisme lié à une entité).

{
      "identifiant" : 1397098,
      "structureReference" : {
        "type" : "STRUCTURE",
        "id" : 120148,
        "nom" : {
          "libelleFr" : "Bourg-en-Bresse Gestion"
        },
        "identifierSitra1" : "01AAHOT100025_struct",
        "state" : "PUBLISHED",
        "adresse" : {
          "adresse1" : "6 rue du Moulin de Brou",
          "codePostal" : "01000",
          "commune" : {
            "id" : 49,
            "code" : "01053",
            "nom" : "Bourg-en-Bresse",
            "pays" : {
              "elementReferenceType" : "Pays",
              "id" : 532,
              "libelleFr" : "France",
              "ordre" : 78
            },
            "codePostal" : "01000"
          }
        },
        "geolocalisation" : {
          "altitude" : 232,
          "valide" : true,
          "geoJson" : {
            "type" : "Point",
            "coordinates" : [ 5.240092, 46.199528 ]
          }
        }
      },
      "nom" : "Bourg-en-Bresse Gestion",
      "type" : {
        "elementReferenceType" : "ReservationType",
        "id" : 475,
        "libelleFr" : "Directe",
        "ordre" : 2
      },
      "moyensCommunication" : [ {
        "identifiant" : 5573922,
        "type" : {
          "elementReferenceType" : "MoyenCommunicationType",
          "id" : 201,
          "libelleFr" : "Téléphone",
          "ordre" : 1
        },
        "coordonnees" : {
          "fr" : "04 74 22 52 66"
        }
      }, {
        "identifiant" : 5573923,
        "type" : {
          "elementReferenceType" : "MoyenCommunicationType",
          "id" : 202,
          "libelleFr" : "Fax",
          "ordre" : 5
        },
        "coordonnees" : {
          "fr" : "04 74 23 09 58"
        }
      }, {
        "identifiant" : 11834935,
        "type" : {
          "elementReferenceType" : "MoyenCommunicationType",
          "id" : 204,
          "libelleFr" : "Mél",
          "ordre" : 2
        },
        "coordonnees" : {
          "fr" : "h0603-gm@accor.com"
        }
      }, {
        "identifiant" : 5573924,
        "type" : {
          "elementReferenceType" : "MoyenCommunicationType",
          "id" : 205,
          "libelleFr" : "Site web (URL)",
          "ordre" : 3
        },
        "coordonnees" : {
          "fr" : "http://www.ibishotel.com"
        }
      } ]
    }

Exports

Format d’un organisme de réservation (cas de l’organisme lié à une entité).

{
      "identifiant" : 1397098,
      "structureReference" : {
        "type" : "STRUCTURE",
        "id" : 120148
      },
      "nom" : "Bourg-en-Bresse Gestion",
      "type" : {
        "elementReferenceType" : "ReservationType",
        "id" : 475
      },
      "moyensCommunication" : [ {
        "identifiant" : 5573922,
        "type" : {
          "elementReferenceType" : "MoyenCommunicationType",
          "id" : 201
        },
        "coordonnees" : {
          "fr" : "04 74 22 52 66"
        }
      }, {
        "identifiant" : 5573923,
        "type" : {
          "elementReferenceType" : "MoyenCommunicationType",
          "id" : 202
        },
        "coordonnees" : {
          "fr" : "04 74 23 09 58"
        }
      }, {
        "identifiant" : 11834935,
        "type" : {
          "elementReferenceType" : "MoyenCommunicationType",
          "id" : 204
        },
        "coordonnees" : {
          "fr" : "h0603-gm@accor.com"
        }
      }, {
        "identifiant" : 5573924,
        "type" : {
          "elementReferenceType" : "MoyenCommunicationType",
          "id" : 205
        },
        "coordonnees" : {
          "fr" : "http://www.ibishotel.com"
        }
      } ]
    }