API - Description - Name - Response

Support DQE
Support DQE
  • Updated

FIRSTNAMESUGGEST response

Success

The JSON response is a dictionary containing the suggest key. Its value is an array of suggested items. Each item is an array of two strings: the first value is the gender of the first name (M, F, or I), and the second value is the suggested first name.

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 example 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 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}		 
{
  "suggest": []
}
Parameter typo https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/?Firtname=Laur&Gender=F&NBResponse=10&Licence={LICENCE_CODE} 
{
  "suggest": []
}

LASTNAMESUGGEST response

Success

The JSON response is a dictionary containing the suggest key. Its value is an array of suggested items. Each item is an array of two strings: the first value is always I, and the second value is the suggested last name.

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 example 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 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}		 
{
  "suggest": []
}
Parameter typo https://{SERVER_ADDRESS}/LASTNAMESUGGEST/?Lasname=DUP&NBResponse=10&Licence={LICENCE_CODE} 
{
  "suggest": []
}

Related to

Was this article helpful?

0 out of 0 found this helpful