Lire les paramètres de l'Administration (application/dictionary)

Ici nous allons voir à quoi correspond le dictionnaire (/dictionary) et comment l'utiliser correctement.

 Restez sur la bonne voie avec notre changelog

Si vous souhaitez être averti lorsque notre équipe planifie/publie de nouvelles fonctionnalités techniques ou si vous utilisez notre API et que vous voulez vous assurer que notre nouvelle fonctionnalité ne cassera pas votre code, nous vous conseillons de vous abonner au canal changelog.

 

Sommaire

A quoi correspond le dictionnaire

Lors de la configuration initiale de BoondManager, un certain nombre de paramètres sont choisis par l’administrateur et alimentent notamment toutes les listes déroulantes disponibles dans l’application. Certaines règles de gestion sont également configurées ainsi.

Lorsque vous cherchez à utiliser l’API avec BoondManager, vous aurez donc besoin de connaître les libellés qui auront été personnalisés par l’Administrateur en interrogeant le Dictionnaire (/dictionary).

Le dictionnaire contient :

  • L’ensemble des Paramètres globaux
  • La liste des pays avec leurs codes ISO
  • La liste des nationalités

 Dans l'application

l’équivalent de ce Dictionnaire se trouve dans Administration > Paramètres globaux. Pour l’appel API cependant, il n’est pas nécessaire d’avoir le droit Administrateur (GET uniquement).
Localisation

Le Dictionnaire renvoyé dépend de la langue utilisateur. A ce jour BoondManager est disponible en Français et en Anglais.

 

Comment l'utiliser

Pour utiliser efficacement le Dictionnaire nous vous conseillons de le charger au démarrage de votre application et de le faire persister lors de la navigation, pour éviter de l’appeler à chaque nouveau chargement de page.

Le JSON du Dictionnaire reprend l’ensemble des libellés utilisés dans les interfaces utilisateurs, et vous permettra donc de faire la correspondance entre l’ID d’un élément reçu lors d’un appel API et son libellé.

 Exemple

J’interroge une fiche candidat et souhaite connaître dans quelle étape de recrutement il se trouve.

Je réalise donc un appel GET sur /candidates/{ID du candidat}/information.

J’obtiens {“state”:”2”} parmi les attributes du JSON. J’appelle ensuite le Dictionnaire avec un appel GET sur /application/dictionary.

En descendant dans le JSON sur le chemin data/setting/state/candidate, j’obtiens {“id”:2,”value”:”En vivier”}. Je sais donc que ce Candidat est à l’étape “En vivier” dans l’interface BoondManager.

 

Nous espérons que cet article vous a été utile et nous vous invitons grandement à nous l'indiquer en votant juste en dessous.

S'il vous reste des questions sans réponse alors n'hésitez surtout pas à contacter notre service Support qui reste à votre écoute :

Contacter le support

Tel : (+33) 03 62 27 61 05

Boondmanager-Mascot-Desk-lg.png

Cet article vous a-t-il été utile ?
Utilisateurs qui ont trouvé cela utile : 1 sur 1

Commentaires

0 commentaire

Cet article n'accepte pas de commentaires.