API Nom — Suggestion de prénoms

Support DQE
Support DQE
  • Mise à jour

Utilisez cet endpoint pour suggérer des prénoms basés sur la saisie de l'utilisateur.

Documentation Nom associée :

Requête GET

Endpoint

https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/?Firstname={FIRST_NAME}&Gender={GENDER}&NBResponse={NUM}&Licence={LICENCE_CODE}&Country={COUNTRY_CODE}&Format={FORMAT}&Verifname=Y

Remplacez les valeurs entre accolades par vos propres informations :

Paramètre Valeur Description Obligatoire/Optionnel
Licence {LICENCE_CODE} Code de licence attribué à votre compte. Obligatoire
Firstname {FIRST_NAME} Partie du prénom déjà saisie par l'utilisateur. Obligatoire
Gender {GENDER} M, F, ou I. Optionnel
NBResponse {NUM} Nombre maximal de suggestions à retourner. Optionnel. Par défaut : 10.
Country {COUNTRY_CODE} Code pays ISO à 3 lettres utilisé pour prioriser les suggestions. Optionnel
Format {FORMAT} Format de sortie souhaité. Optionnel. Par défaut : 0.
Verifname Y Vérifie si le prénom existe sans autocomplétion. Optionnel

Valeurs de format

Format Description
0 Prénom en majuscules sans accents.
1 Première lettre en majuscule sans accents.
2 Prénom en minuscules sans accents.

Requête POST

Endpoint

https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/

Ajoutez les paramètres suivants dans le corps de la requête au format x-www-form-urlencoded.

Paramètre Valeur Description Obligatoire/Optionnel
Licence {LICENCE_CODE} Code de licence attribué à votre compte. Obligatoire
Firstname {FIRST_NAME} Partie du prénom déjà saisie par l'utilisateur. Obligatoire
Gender {GENDER} M, F, ou I. Optionnel
NBResponse {NUM} Nombre maximal de suggestions à retourner. Optionnel. Par défaut : 10.
Country {COUNTRY_CODE} Code pays ISO à 3 lettres utilisé pour prioriser les suggestions. Optionnel
Format {FORMAT} Format de sortie souhaité. Optionnel. Par défaut : 0.
Verifname Y Vérifie si le prénom existe sans autocomplétion. Optionnel

Valeurs de format

Format Description
0 Prénom en majuscules sans accents.
1 Première lettre en majuscule sans accents.
2 Prénom en minuscules sans accents.

Réponse

Réponse de succès

La réponse JSON est un dictionnaire contenant la clé suggest. Sa valeur est un tableau d'éléments suggérés. Chaque élément est un tableau de deux chaînes : la première valeur est le genre du prénom (M, F, ou I), et la seconde valeur est le prénom suggéré.

Clé Description France International
suggest[X][0] F : féminin
M : masculin
I : inconnu		 STRING(1) STRING(1)
suggest[X][1] Prénom associé. STRING(255) STRING(255)

Exemple :

{
  "suggest": [
    ["F", "ALICE"],
    ["F", "ALICE-ANNE"],
    ["F", "ALICE-MARIE"]
  ]
}

Réponse d'erreur

Type d'erreur Exemple de requête Type de réponse
Paramètre Licence manquant, vide ou incorrect https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/?Firstname=Laur&Gender=F&NBResponse=10 {}
Paramètre Firstname manquant ou vide https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/?Gender=F&NBResponse=10&Licence={LICENCE_CODE} {"suggest": []}
Erreur de frappe dans le paramètre https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/?Firtname=Laur&Gender=F&NBResponse=10&Licence={LICENCE_CODE} {"suggest": []}

Voir aussi

Associé à

Cet article vous a-t-il été utile ?

Utilisateurs qui ont trouvé cela utile : 0 sur 0