Documentation technique

Filtrage des langues

De manière à alléger les flux et à vous permettre de focaliser votre travail sur les informations utiles, les flux API sont filtrables par langue

Comportement par défaut

Par défaut, seuls les libellés en langue française sont inclus dans la réponse.

Les champs concernés par le filtrage sont les champs multilingues (libelle*), les libellés des éléments de référence (libelle*) et le champ (coordonnees.*) des moyens de communication.
Les champs multimédia ne sont pas concernés par ce filtrage.

Paramétrage du filtrage

Pour changer les langues fournies dans la sortie, il faut les indiquer dans le paramètre locales. Il est possible d’indiquer plusieurs langues.
Les valeurs possibles sont :

  • Français : fr
  • Anglais : en
  • Allemand : de
  • Hollandais : nl
  • Italien : it
  • Espagnol : es
  • Russe : ru
  • Chinois : zh
  • Portugais (Brésil) : pt-br

Le paramètre locales peut-être fourni dans deux formats différents en fonction de la requête :

sans paramètre query

le paramètre est passé sous la forme d’un query parameter (?locales=…&). Chaque langue est séparée par une virgule.

locales=fr,en

avec paramètre query

l’attribut locales de l’objet de requête est une liste de chaînes de caractères. Chaque chaine de caractère correspond à un nom de champ ou à un alias.

...
"locales" : [ "fr", "en" ],
...