Utilice este endpoint para sugerir apellidos basados en la entrada del usuario.
Documentación relacionada de Name:
Solicitud GET
Endpoint
https://{SERVER_ADDRESS}/LASTNAMESUGGEST/?Lastname={NAME}&NBResponse={NUM}&Licence={LICENCE_CODE}Sustituya los valores entre llaves por su propia información:
| Parámetro | Valor | Descripción | Obligatorio/Opcional |
|---|---|---|---|
| Licence | {LICENCE_CODE} |
Código de licencia asignado a su cuenta. | Obligatorio |
| Lastname | {NAME} |
Parte del apellido ya introducida por el usuario. | Obligatorio |
| NBResponse | {NUM} |
Número máximo de sugerencias a devolver. | Opcional. Predeterminado: 10. |
| Format | {FORMAT} |
Formato de salida deseado. | Opcional. Predeterminado: 0. |
Valores de Format
| Format | Descripción |
|---|---|
0 |
Nombre en mayúsculas sin acentos. |
1 |
Primera letra en mayúscula sin acentos. |
2 |
Nombre en minúsculas sin acentos. |
Solicitud POST
Endpoint
https://{SERVER_ADDRESS}/LASTNAMESUGGEST/Añada los siguientes parámetros en el cuerpo de la solicitud utilizando x-www-form-urlencoded.
| Parámetro | Valor | Descripción | Obligatorio/Opcional |
|---|---|---|---|
| Licence | {LICENCE_CODE} |
Código de licencia asignado a su cuenta. | Obligatorio |
| Lastname | {NAME} |
Parte del apellido ya introducida por el usuario. | Obligatorio |
| NBResponse | {NUM} |
Número máximo de sugerencias a devolver. | Opcional. Predeterminado: 10. |
| Format | {FORMAT} |
Formato de salida deseado. | Opcional. Predeterminado: 0. |
Valores de Format
| Format | Descripción |
|---|---|
0 |
Nombre en mayúsculas sin acentos. |
1 |
Primera letra en mayúscula sin acentos. |
2 |
Nombre en minúsculas sin acentos. |
Respuesta
Respuesta correcta
La respuesta JSON es un diccionario que contiene la clave suggest. Su valor es un array de elementos sugeridos. Cada elemento es un array de dos cadenas: el primer valor es siempre I, y el segundo valor es el apellido sugerido.
| Clave | Descripción | Francia | Internacional |
|---|---|---|---|
| suggest[X][0] |
I: desconocido |
STRING(1) | STRING(1) |
| suggest[X][1] | Apellido asociado. | STRING(255) | STRING(255) |
Ejemplo:
{
"suggest": [
["I", "DUPONT"],
["I", "DUPOUY"],
["I", "DUPORT"]
]
}Respuesta de error
| Tipo de error | Ejemplo de solicitud | Tipo de respuesta |
|---|---|---|
Parámetro Licence faltante, vacío o incorrecto |
https://{SERVER_ADDRESS}/LASTNAMESUGGEST/?Lastname=DUP&NBResponse=10 |
{} |
Parámetro Lastname faltante o vacío |
https://{SERVER_ADDRESS}/LASTNAMESUGGEST/?NBResponse=10&Licence={LICENCE_CODE} |
{"suggest": []} |
| Error tipográfico en el parámetro | https://{SERVER_ADDRESS}/LASTNAMESUGGEST/?Lasname=DUP&NBResponse=10&Licence={LICENCE_CODE} |
{"suggest": []} |
Véase también
Relacionada con