Name API — Validación de nombre de pila

Support DQE
Support DQE
  • Actualización

Utilice este endpoint para sugerir nombres de pila basados en la entrada del usuario.

Documentación relacionada de Name:

Solicitud GET

Endpoint

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

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
Firstname {FIRST_NAME} Parte del nombre de pila ya introducida por el usuario. Obligatorio
Gender {GENDER} M, F, o I. Opcional
NBResponse {NUM} Número máximo de sugerencias a devolver. Opcional. Predeterminado: 10.
Country {COUNTRY_CODE} Código de país ISO de 3 letras utilizado para priorizar las sugerencias. Opcional
Format {FORMAT} Formato de salida deseado. Opcional. Predeterminado: 0.
Verifname Y Comprueba si el nombre de pila existe sin autocompletar. Opcional

Valores de Format

Format Descripción
0 Nombre de pila en mayúsculas sin acentos.
1 Primera letra en mayúscula sin acentos.
2 Nombre de pila en minúsculas sin acentos.

Solicitud POST

Endpoint

https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/

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
Firstname {FIRST_NAME} Parte del nombre de pila ya introducida por el usuario. Obligatorio
Gender {GENDER} M, F, o I. Opcional
NBResponse {NUM} Número máximo de sugerencias a devolver. Opcional. Predeterminado: 10.
Country {COUNTRY_CODE} Código de país ISO de 3 letras utilizado para priorizar las sugerencias. Opcional
Format {FORMAT} Formato de salida deseado. Opcional. Predeterminado: 0.
Verifname Y Comprueba si el nombre de pila existe sin autocompletar. Opcional

Valores de Format

Format Descripción
0 Nombre de pila en mayúsculas sin acentos.
1 Primera letra en mayúscula sin acentos.
2 Nombre de pila 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 el género del nombre de pila (M, F, o I), y el segundo valor es el nombre de pila sugerido.

Clave Descripción Francia Internacional
suggest[X][0] F: femenino
M: masculino
I: desconocido		 STRING(1) STRING(1)
suggest[X][1] Nombre de pila asociado. STRING(255) STRING(255)

Ejemplo:

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

Respuesta de error

Tipo de error Ejemplo de solicitud Tipo de respuesta
Parámetro Licence faltante, vacío o incorrecto https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/?Firstname=Laur&Gender=F&NBResponse=10 {}
Parámetro Firstname faltante o vacío https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/?Gender=F&NBResponse=10&Licence={LICENCE_CODE} {"suggest": []}
Error tipográfico en el parámetro https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/?Firtname=Laur&Gender=F&NBResponse=10&Licence={LICENCE_CODE} {"suggest": []}

Véase también

Relacionada con

¿Fue útil este artículo?

Usuarios a los que les pareció útil: 0 de 0