FIRSTNAMESUGGEST response
Success
The "JSON" response is a dictionary containing the "suggest" key whose value is an array of all suggested items. Each element is an array of two strings: first the gender of the first name ("M" or "F") and then the first name itself.
| Key | Description | France | International |
| suggest[X][0] |
F: feminine M: masculine I: unknown |
STRING(1) | STRING(1) |
| suggest[X][1] | Associated first name | STRING(255) | STRING(255) |
Example :
{
"suggest": [
["F", "ALICE"],
["F", "ALICE-ANNE"],
["F", "ALICE-MARIE"]
]
}
Errors
| Error type | Request | Response type |
| Missing “Licence” parameter |
https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/?Firstname=Laur&Gender=F&NBResponse=10 |
{
|
|
Empty “Licence” parameter |
https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/?Firstname=Laur&Gender=F&NBResponse=10&Licence= |
{
|
| Incorrect Licence number (expired, out of scope, nonexistent) | https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/?Firstname=Laur&Gender=F&NBResponse=10&Licence={INCORRECT_LICENCE_CODE} |
{
|
| Missing or Empty “Firstname” parameter |
https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/?Gender=F&NBResponse=10&Licence={LICENCE_CODE} https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/?Firstname=&Gender=F&NBResponse=10&Licence={LICENCE_CODE} |
{
|
| Error on a parameter | https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/?Firtname=Laur&Gender=F&NBResponse=10&Licence={LICENCE_CODE |
{
|
LASTNAMESUGGEST response
Success
The "JSON" response is a dictionary containing the "suggest" key whose value is an array of all suggested items. Each element is an array of two strings: first the gender of the last name (always “I”) and then the last name itself.
| Key | Description | France | International |
| suggest[X][0] | I: unknown | STRING(1) | STRING(1) |
| suggest[X][1] | Associated last name | STRING(255) | STRING(255) |
Example :
{
"suggest": [["I",
"DUPONT"],
["I",
"DUPOUY"],
["I",
"DUPORT"],
["I",
"DUPONCHEL"],
["I",
"DUPOUX"]]
}
Errors
| Error type | Request | Response type |
| Missing “Licence” parameter | https://{SERVER_ADDRESS}/LASTNAMESUGGEST/?Lastname=DUP&NBResponse=10 |
{
|
|
Empty “Licence” parameter |
https://{SERVER_ADDRESS}/LASTNAMESUGGEST/?Lastname=DUP&NBResponse=10&Licence= |
{
|
| Incorrect Licence number (expired, out of scope, nonexistent) | https://{SERVER_ADDRESS}/LASTNAMESUGGEST/?Lastname=DUP&NBResponse=10&Licence={INCORRECT_LICENCE_CODE} |
{
|
| Missing or Empty “Lastname” parameter |
https://{SERVER_ADDRESS}/LASTNAMESUGGEST/?NBResponse=10&Licence={LICENCE_CODE} https://{SERVER_ADDRESS}/LASTNAMESUGGEST/?Lastname=&NBResponse=10&Licence={LICENCE_CODE} |
{
|
| Error on a parameter | https://{SERVER_ADDRESS}/LASTNAMESUGGEST/?Lasname=DUP&NBResponse=10&Licence={LICENCE_CODE} |
{
|
Related to