API de servicios

Tema Anterior
Próximo Tema

Separador de Nombres

API de servicios Servicios JSON 2.5 Separador de Nombres

Separador de Nombres

 

Servicio de Separador de Nombres (Name Normalize)

El cliente debe enviar una estructura de datos debiendo completar mínimamente los campos que se detallan a continuación:

  • name: deberá completarse con el nombre completo que se requiere separar, puede no completarse si se informa en lastname.
  • lastName: deberá completarse con el nombre completo que se requiere separar, puede no completarse si se informa en name.

Los siguientes campos son los Headers Obligatorios que deben informarse:

  • Authorization: Header con el ID de acceso de cliente (ClientAccessCode).
  • Content-Type: Header que se informa el tipo de contenido del mensaje, se debe informar application/json.

Método: POST

Endpoint: https://ws.merlindataquality.com/name/normalize

Parámetros de llamada
Parámetro Descripción Longitud Tipo
Authorization Identificador único de usuarios. Este valor identifica y valida en cada invocación a un usuario determinado. Este valor tiene asociado los roles que le corresponden al usuario. 64 String
Content-Type Header que se informa el tipo de contenido del mensaje, se debe informar application/json. String
name Nombre de la persona a normalizar. 64 String
lastName Apellido de la persona a normalizar. 64 String
gender Determina la identidad de género de la persona. (M o F) 1 String
Mensaje JSON de petición
{
  "name": "JUAN JOSE PEREZ PEREZ",
  "lastName": "",
  "gender": ""
}
Respuesta

La respuesta está compuesta por una lista de elementos que tienen la siguiente estructura:

Parámetro Descripción Longitud Tipo
status Indica el estado de normalización y/o validación. 2 String
statusReason Indica la razón con referencia al estado de normalización y/o validación. 2 String
transactionId Merlin asigna un id de transacción por consulta. 40 String
nName Son los datos de nombre normalizado.. – –
name Nombre/s de la persona normalizada o estandarizada. 64 String
lastName Apellido/s de la persona normalizada o estandarizada.. 64 String
gender Determina la identidad de género de la persona. (F o M) 1 String
personType Identificador del tipo de persona: PF (persona física). 2 String
merlinCustomValues Valores desarrollados por demanda del cliente o que se proveen opcionalmente. – Object
Mensaje JSON de respuesta
{
    "status": "CO",
    "statusReason": "SM",
    "transactionId": "f3aa1d7f-bdf6-4258-83f0-500d3424e853",
    "nName": {
        "name": "JUAN JOSE",
        "lastName": "PEREZ PEREZ",
        "gender": "M",
        "personType": "PF",
        "merlinCustomValues": {}
    }
}
Tema Anterior
Volver a la Lección
Próximo Tema