Aller au contenu principal
Page non répertoriée
Cette page n'est pas répertoriée. Les moteurs de recherche ne l'indexeront pas, et seuls les utilisateurs ayant un lien direct peuvent y accéder.

Liste des référentiels

Description​

Retourne la liste des référentiels disponibles. Pour chaque référentiel, la réponse inclut un referentialCode (identifiant) et une description courte en français pour aider à comprendre le rôle du référentiel.

Chaque code peut ensuite être interrogé via la route Valeurs d'un référentiel pour obtenir les valeurs disponibles (libellés, identifiants).


Endpoint​

GET https://api.mytalentplug.com/resources/v1/referentials

Authentification​

  • Requise : Oui
  • Type : Bearer Authentication
  • Exemple d'en-tête :
Authorization: Bearer <token>

Requête​

Aucun paramètre de query ou de corps n'est attendu.


Réponse​

La réponse est au format JSON.

Réponse 200 (succès)​

Exemple​
{
"referentials": [
{
"referentialCode": "applicant_degree",
"description": "Niveau d'études du candidat."
},
{
"referentialCode": "job_contract",
"description": "Type de contrat (CDI, CDD, intérim, etc.)."
}
]
}
Détail des champs

Propriétés de la réponse​

ChampTypeDescription
referentialsarrayListe ordonnée des référentiels exposés. Voir referentials.

Schéma referentials​

ChampTypeDescription
referentialCodestringIdentifiant du référentiel (à utiliser dans Valeurs d'un référentiel).
descriptionstringLibellé explicatif du référentiel (ne remplace pas les valeurs renvoyées par Valeurs d'un référentiel).

Réponses d'erreur​

Code HTTPMessageDescription
401UnauthorizedJeton d'accès manquant ou invalide
403ForbiddenAccès refusé
429Too Many RequestsLimite d'appels dépassée (voir Limites d'appels)
500Internal Server ErrorLe serveur a rencontré un problème inattendu

Exemple de requête avec curl​

curl -X GET 'https://api.mytalentplug.com/resources/v1/referentials' \
-H 'Authorization: Bearer <token>'