v002/referentiel/champs - Le site pour les développeurs Apidae

1.61, juillet 2024, #35034

{{API_ENDPOINT}}/v002/referentiel/champs/?query={"apiKey":"{{apiKey}}","projetId":"{{projetId}}","nom":"prestations.activite","type":"SAISIE"}

Point d’entrée

url : /v002/referentiel/champs/
méthodes : GET ou POST
paramètres :
- query : représentation au format JSON de la requête
  - projetId : identifiant du projet de consultation
  - apiKey : clé du projet de consultation utilisé
  - nom : filtre de recherche de champs par nom : il s’agit bien d’une recherche et pas d’une valeur stricte. nom=prestations renverra par exemple tous les champs dont le nom comporte le mot prestations (prestations.activites, prestations.services…)
  - type : DEFAUT, SAISIE, RECHERCHE, EXPORT_EXCEL : type d’information sur le champ recherché : DEFAUT est toujours renseigné, les autres valeurs sont dédiées à des usages particuliers, et permettent d’adapter l’aide utilisateurs aux cas d’usages rencontrés.

Réponse

Réponse au format JSON : chaque entrée possède les informations suivantes :

path
type (DEFAUT, SAISIE, RECHERCHE, EXPORT_EXCEL)
nom : le libellé à afficher pour le champ dans le contexte donné (type)
objetTouristiqueType : facultatif : ex : HEBERGEMENT_LOCATIF
Il peut arriver en IHM qu’on souhaite afficher une aide particulière pour un champ selon le type objet concerné. Il y a cependant toujours une valeur par défaut présente (entrée sans objetTouristiqueType).
texteAideCourt : facultatif : détail d’information fourni en IHM dans le contexte donné
texteAideLong : facultatif : en IHM, souvent affiché à l’aide d’un « + » au survol ou au clic de l’utilisateur
enums : tableau de valeurs pour les champs dont la liste est stricte (ex: descriptionTarif.indicationTarif »). Ces valeurs ne sont pour le moment fournies qu’en français.
- nom (ex: ACCES_LIBRE)
- libelle (ex: Accès libre)
dateCreation
dateDerniereModification

Exemple de réponse

[
    {
        "path": "descriptionTarif",
        "nom": "Description tarifs",
        "type": "DEFAUT",
        "dateCreation": "2014-01-13 20:55:28",
        "dateDerniereModification": "2014-01-14 06:28:14"
    },
    {
        "path": "descriptionTarif.complement",
        "nom": "Complément tarifs",
        "type": "DEFAUT",
        "texteAideCourt": "Ce champ peut être utilisé pour décrire des tarifs spécifiques : promotion, gratuité, tarif réduit, gratuité accompagnateur…\r\nou des tarifs ne pouvant être saisis dans les champs prédéfinis du bloc \"Périodes tarifaires\".\r\n\r\nUtiliser le symbole € pour les euros, XPF pour les francs pacifiques et CHF pour les francs suisses.",
        "dateCreation": "2014-01-13 20:55:28",
        "dateDerniereModification": "2023-11-09 09:00:50"
    },
    {
        "path": "descriptionTarif.conditions.conditionEnfantAgeMax",
        "nom": "Age max pour bénéficier du tarif enfant",
        "type": "DEFAUT",
        "dateCreation": "2015-05-05 19:14:16",
        "dateDerniereModification": "2015-05-05 23:02:00"
    },
    {
        "path": "descriptionTarif.conditions.conditionEnfantAgeMin",
        "nom": "Age min pour bénéficier du tarif enfant",
        "type": "DEFAUT",
        "dateCreation": "2015-05-05 19:14:16",
        "dateDerniereModification": "2016-09-27 11:00:54"
    },
    {
        "path": "descriptionTarif.conditions.conditionJuniorAgeMax",
        "nom": "Age max pour bénéficier du tarif adolescent",
        "type": "DEFAUT",
        "dateCreation": "2015-05-05 19:14:16",
        "dateDerniereModification": "2017-12-06 16:33:31"
    },
    {
        "path": "descriptionTarif.conditions.conditionJuniorAgeMin",
        "nom": "Age min pour bénéficier du tarif adolescent",
        "type": "DEFAUT",
        "dateCreation": "2015-05-05 19:14:16",
        "dateDerniereModification": "2017-12-06 16:33:42"
    },
    {
        "path": "descriptionTarif.dateFinDernierePeriodeTarif",
        "nom": "Date de fin de la dernière période tarifaire",
        "type": "RECHERCHE",
        "dateCreation": "2014-01-14 06:28:14",
        "dateDerniereModification": "2014-01-14 06:28:14"
    },
    {
        "path": "descriptionTarif.dateFinDernierePeriodeTarif",
        "nom": "Date de fin de la dernière période tarifaire",
        "type": "DEFAUT",
        "dateCreation": "2014-01-13 20:55:28",
        "dateDerniereModification": "2014-01-14 06:28:14"
    },
    {
        "path": "descriptionTarif.indicationTarif",
        "nom": "Indication tarif",
        "type": "DEFAUT",
        "texteAideCourt": "En sélectionnant une des valeurs suivantes, vos prestations sont considérées comme gratuites.\r\n- Gratuit\r\n- En accès libre\r\n- Entrée libre\r\n- Participation libre\r\n\r\nLa facette \"Gratuit\" de la recherche intuitive renverra les fiches avec les valeurs indiquées ci-dessus.",
        "dateCreation": "2014-03-24 19:34:55",
        "dateDerniereModification": "2014-12-11 13:59:30",
        "enums": [
            {
                "nom": "GRATUIT",
                "libelle": "Gratuit"
            },
            {
                "nom": "ACCES_LIBRE",
                "libelle": "En accès libre"
            },
            {
                "nom": "ACCES_LIBRE_STATIONNEMENT_PAYANT_OBLIGATOIRE",
                "libelle": "En accès libre mais stationnement payant obligatoire"
            },
            {
                "nom": "ACCES_LIBRE_TRANSPORT_PAYANT",
                "libelle": "En accès libre mais transport payant"
            },
            {
                "nom": "ENTREE_LIBRE",
                "libelle": "Entrée libre"
            },
            {
                "nom": "PARTICIPATION_LIBRE",
                "libelle": "Participation libre"
            },
            {
                "nom": "PAYANT_TARIFS_NON_COMMUNIQUES",
                "libelle": "Payant, tarifs non communiqués"
            },
            {
                "nom": "PAYANT",
                "libelle": "Payant"
            }
        ]
    },
    {
        "path": "descriptionTarif.periodes",
        "nom": "Périodes tarifaires",
        "type": "DEFAUT",
        "texteAideCourt": "Cette zone permet de saisir les périodes tarifaires au \"format numérique\" et sert pour les recherches sur les périodes tarifaires dans Apidae et sur vos projets numériques.",
        "dateCreation": "2014-01-13 20:55:28",
        "dateDerniereModification": "2018-02-02 10:04:06"
    },
    {
        "path": "descriptionTarif.periodes",
        "nom": "Tarifs",
        "type": "RECHERCHE",
        "dateCreation": "2014-01-14 06:28:14",
        "dateDerniereModification": "2014-01-14 06:28:14"
    },
    {
        "path": "descriptionTarif.periodes[].dateFin",
        "nom": "Dates de fin des périodes tarifaires",
        "type": "DEFAUT",
        "dateCreation": "2014-01-13 20:55:28",
        "dateDerniereModification": "2014-01-14 06:28:14"
    },
    {
        "path": "descriptionTarif.periodes[].tarifs",
        "nom": "Tarifs",
        "type": "DEFAUT",
        "dateCreation": "2014-01-13 20:55:28",
        "dateDerniereModification": "2014-01-14 06:28:14"
    },
    {
        "path": "descriptionTarif.periodes[].tarifsEnClair",
        "nom": "Tarifs en clair",
        "type": "DEFAUT",
        "dateCreation": "2014-01-13 20:55:28",
        "dateDerniereModification": "2014-01-27 22:06:27"
    },
    {
        "path": "descriptionTarif.periodes[].tarifs[].maximum",
        "nom": "Maximum",
        "type": "DEFAUT",
        "dateCreation": "2014-01-13 20:55:28",
        "dateDerniereModification": "2014-01-14 06:28:14"
    },
    {
        "path": "descriptionTarif.periodes[].tarifs[].minimum",
        "nom": "Minimum",
        "type": "DEFAUT",
        "dateCreation": "2014-01-13 20:55:28",
        "dateDerniereModification": "2014-01-14 06:28:14"
    },
    {
        "path": "descriptionTarif.periodes[].tarifs[].precisionTarif",
        "nom": "Précisions tarifs",
        "type": "DEFAUT",
        "dateCreation": "2014-01-13 20:55:28",
        "dateDerniereModification": "2014-01-14 06:28:14"
    },
    {
        "path": "descriptionTarif.periodes[].tarifs[].type",
        "nom": "Type de tarif",
        "type": "DEFAUT",
        "dateCreation": "2014-01-13 20:55:28",
        "dateDerniereModification": "2014-01-14 06:28:14"
    },
    {
        "path": "descriptionTarif.tarifsEnClair",
        "nom": "Tarifs en clair",
        "type": "DEFAUT",
        "texteAideCourt": "Ce bloc sert à synthétiser l’ensemble des informations d’ouverture de la fiche. Il est très utile pour les éditions ou dans les fiches détaillées sur le web (un seul champ à exporter).",
        "dateCreation": "2014-01-13 20:55:29",
        "dateDerniereModification": "2014-01-27 22:06:52"
    },
    {
        "path": "descriptionTarif.tarifsEnClairAutomatique",
        "nom": "Génération des tarifs en clair automatique",
        "type": "DEFAUT",
        "texteAideCourt": "Cliquez sur le bouton \"Actualiser les tarifs en clair\" pour visualiser les modifications effectuées dans le tableau des tarifs. \r\nEn cliquant sur \"Publier\", les informations seront également mis à jour.",
        "dateCreation": "2014-01-13 20:55:29",
        "dateDerniereModification": "2018-08-09 15:55:44"
    },
    {
        "path": "descriptionTarif.tarifsEnClairGenerationMode",
        "nom": "Mode de génération des tarifs en clair",
        "type": "DEFAUT",
        "texteAideCourt": "En activant cette case, le tarif en clair sera calculé automatiquement à chaque fois que vous interviendrez sur les périodes tarifaires et dans toutes les langues. \r\nAttention, les champs \"complément tarif\" et \"précision tarif\" ne sont pas traduits automatiquement.",
        "texteAideLong": "La génération automatique permet l'optimisation des fonctions suivantes du menu traitements :\r\n- Ajouter une période tarifaire\r\n- Supprimer des périodes périmées",
        "dateCreation": "2014-01-13 20:55:29",
        "dateDerniereModification": "2018-08-09 15:56:44",
        "enums": [
            {
                "nom": "AUTOMATIQUE",
                "libelle": "Automatique"
            },
            {
                "nom": "MANUEL",
                "libelle": "Manuel"
            }
        ]
    },
    {
        "path": "descriptionTarif.tarifsPeriodesState",
        "nom": "Etat des périodes tarifaires",
        "type": "DEFAUT",
        "dateCreation": "2022-11-08 18:06:55",
        "dateDerniereModification": "2022-11-21 14:10:12"
    },
    {
        "path": "descriptionTarif.tarifsSaisieFilleul",
        "nom": "Tarifs",
        "type": "DEFAUT",
        "dateCreation": "2014-01-13 20:55:29",
        "dateDerniereModification": "2014-01-14 06:28:14"
    },
    {
        "path": "informationsDomaineSkiable.validiteTarifEnfant",
        "nom": "Validité tarif enfant",
        "type": "DEFAUT",
        "dateCreation": "2014-01-13 20:55:33",
        "dateDerniereModification": "2014-01-14 06:28:14"
    },
    {
        "path": "informationsDomaineSkiable.validiteTarifSenior",
        "nom": "Validité tarif sénior",
        "type": "DEFAUT",
        "dateCreation": "2014-01-13 20:55:33",
        "dateDerniereModification": "2014-01-14 06:28:14"
    },
    {
        "path": "prestations.tailleGroupeMin",
        "nom": "Nb pers min pour tarif groupe",
        "type": "DEFAUT",
        "texteAideCourt": "Notez ici le nombre de personnes minimum pour bénéficier de l'accès au tarif groupe.",
        "dateCreation": "2014-01-13 20:55:40",
        "dateDerniereModification": "2017-06-15 09:32:06"
    },
    {
        "path": "tourismeAffaires.sallesReunion[].tarifJournee",
        "nom": "Tarif journée",
        "type": "DEFAUT",
        "dateCreation": "2014-01-13 20:55:41",
        "dateDerniereModification": "2014-01-14 06:28:16"
    },
    {
        "path": "tourismeAffaires.sallesReunion[].tarifJournee.maximum",
        "nom": "Maximum",
        "type": "DEFAUT",
        "dateCreation": "2014-01-13 20:55:41",
        "dateDerniereModification": "2014-01-14 06:28:16"
    },
    {
        "path": "tourismeAffaires.sallesReunion[].tarifJournee.minimum",
        "nom": "Minimum",
        "type": "DEFAUT",
        "dateCreation": "2014-01-13 20:55:41",
        "dateDerniereModification": "2014-01-14 06:28:16"
    },
    {
        "path": "tourismeAffaires.sallesReunion[].tarifResident",
        "nom": "Tarif résident",
        "type": "DEFAUT",
        "dateCreation": "2014-01-13 20:55:41",
        "dateDerniereModification": "2014-01-14 06:28:16"
    },
    {
        "path": "tourismeAffaires.sallesReunion[].tarifResident.maximum",
        "nom": "Maximum",
        "type": "DEFAUT",
        "dateCreation": "2014-01-13 20:55:41",
        "dateDerniereModification": "2014-01-14 06:28:16"
    },
    {
        "path": "tourismeAffaires.sallesReunion[].tarifResident.minimum",
        "nom": "Minimum",
        "type": "DEFAUT",
        "dateCreation": "2014-01-13 20:55:41",
        "dateDerniereModification": "2014-01-14 06:28:16"
    },
    {
        "path": "tourismeAffaires.sallesReunion[].tarifSalle",
        "nom": "Tarif salle",
        "type": "DEFAUT",
        "dateCreation": "2014-01-13 20:55:41",
        "dateDerniereModification": "2014-01-14 06:28:16"
    },
    {
        "path": "tourismeAffaires.sallesReunion[].tarifSalle.maximum",
        "nom": "Maximum",
        "type": "DEFAUT",
        "dateCreation": "2014-01-13 20:55:41",
        "dateDerniereModification": "2014-01-14 06:28:16"
    },
    {
        "path": "tourismeAffaires.sallesReunion[].tarifSalle.minimum",
        "nom": "Minimum",
        "type": "DEFAUT",
        "dateCreation": "2014-01-13 20:55:41",
        "dateDerniereModification": "2014-01-14 06:28:16"
    }
]