Utilisez cet endpoint pour suggérer des noms de famille basés sur la saisie de l'utilisateur.
Documentation Nom associée :
Requête GET
Endpoint
https://{SERVER_ADDRESS}/LASTNAMESUGGEST/?Lastname={NAME}&NBResponse={NUM}&Licence={LICENCE_CODE}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 |
| Lastname | {NAME} |
Partie du nom de famille déjà saisie par l'utilisateur. | Obligatoire |
| NBResponse | {NUM} |
Nombre maximal de suggestions à retourner. | Optionnel. Par défaut : 10. |
| Format | {FORMAT} |
Format de sortie souhaité. | Optionnel. Par défaut : 0. |
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}/LASTNAMESUGGEST/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 |
| Lastname | {NAME} |
Partie du nom de famille déjà saisie par l'utilisateur. | Obligatoire |
| NBResponse | {NUM} |
Nombre maximal de suggestions à retourner. | Optionnel. Par défaut : 10. |
| Format | {FORMAT} |
Format de sortie souhaité. | Optionnel. Par défaut : 0. |
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 toujours I, et la seconde valeur est le nom de famille suggéré.
| Clé | Description | France | International |
|---|---|---|---|
| suggest[X][0] |
I : inconnu |
STRING(1) | STRING(1) |
| suggest[X][1] | Nom de famille associé. | STRING(255) | STRING(255) |
Exemple :
{
"suggest": [
["I", "DUPONT"],
["I", "DUPOUY"],
["I", "DUPORT"]
]
}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}/LASTNAMESUGGEST/?Lastname=DUP&NBResponse=10 |
{} |
Paramètre Lastname manquant ou vide |
https://{SERVER_ADDRESS}/LASTNAMESUGGEST/?NBResponse=10&Licence={LICENCE_CODE} |
{"suggest": []} |
| Erreur de frappe dans le paramètre | https://{SERVER_ADDRESS}/LASTNAMESUGGEST/?Lasname=DUP&NBResponse=10&Licence={LICENCE_CODE} |
{"suggest": []} |
Voir aussi
Associé à