{{API_ENDPOINT}}/v002/referentiel/elements-reference/autorises/?query={"apiKey":"{{apiKey}}","projetId":{{projetId}},"type":"FETE_ET_MANIFESTATION","elementReferenceIds":[1958,4641],"field":"descriptionTarif.modesPaiement"}

Cette API permet de connaître les critères autorisés dans un contexte donné, en renvoyant seulement les critères autorisés (elle est donc un complément de l’API /interdits/).

Ex : Dans un formulaire de saisie de manifestation, l’utilisateur renseigne un type (Culture) et une catégorie (Chasse aux oeufs) : on cherche à connaître la liste des moyens de paiement (donc seulement les paiements autorisés).

[
    {
        "elementReferenceType": "ModePaiement",
        "id": 6284,
        "libelleFr": "Apple Pay",
        ...
    },
    {
        "elementReferenceType": "ModePaiement",
        "id": 1268,
        "libelleFr": "Carte bancaire/crédit",
        ...
    },
    {
        "elementReferenceType": "ModePaiement",
        "id": 1271,
        "libelleFr": "Chèque",
        ...
    },
    {
        "elementReferenceType": "ModePaiement",
        "id": 5646,
        "libelleFr": "Chéquier Jeunes",
        ...
    },
    ...
]

Fonctionnement

Méthode : GET

Paramètre : query, format JSON

• ex : query={"apiKey":"{{apiKey}}","projetId":{{projetId}},"type":"FETE_ET_MANIFESTATION","elementReferenceIds":[1958,4641],"field":"descriptionTarif.modesPaiement"}
• Paramètres de query :
  • projetId : int
  • apiKey : string
  • type : string : type objet
  • elementReferenceIds : array<int> : listes des critères de « contexte » (identifiants d’éléments de référence)
  • field : string : correspond au path du champ concerné

Les elementReferenceIds qui génèrent des interdictions sont limités et sont les suivants :

ActiviteCulturellePrestation
ActiviteSportivePrestation
ActiviteType
CommerceEtServiceType
CommerceEtServiceTypeDetaille
DegustationTypeProduit
DomaineSkiableClassification
EquipementActivite
FeteEtManifestationCategorie
FeteEtManifestationType
HebergementCollectifType
HebergementLocatifType
HotelleriePleinAirType
HotellerieType
PatrimoineCulturelType
PatrimoineNaturelCategorie
RestaurationType
StructureType
TerritoireType

Il reste possible de passer n’importe quels autres critères dans elementsReferenceIds sans générer d’erreur, mais ils n’auront pas d’influence sur les résultats retournés.