API de servicios

Tema Anterior
Próximo Tema

Búsqueda Predictiva

API de servicios Servicios JSON 2.5 Búsqueda Predictiva

Búsqueda Predictiva

 

Servicio de Búsqueda Predictiva

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

  • stringSearch: Cadena de caracteres a buscar. Valor que corresponde a la calle o localidad

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: GET

Endpoint: https://ws.merlindataquality.com/predictivesearch/search

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
stringSearch Valor que se busca para las calles y localidades. 64 String
level1 País originario del documento a consultar 64 String
Mensaje JSON de petición

/predictivesearch/search?stringSearch=Jose Varela

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. 3 String
statusReason Código de motivo correspondiente al estado de la normalización. String
transactionId Merlin asigna un id de transacción por consulta. 40 String
mSuggest Objeto que contiene el listado de direcciónes sugeridas. Object
level1 Corresponde al primer nivel (País) administrativo de una dirección.

Ver tabla de especificación por nivel.
Campo que se encuentra dentro del objeto mSuggest.		 64 String
level2 Corresponde al segundo nivel administrativo de una dirección. Por ejemplo para Argentina, corresponde a Provincia.
Ver tabla de especificación por nivel.
Campo que se encuentra dentro del objeto mSuggest.		 64 String
level3 Corresponde al tercer nivel administrativo de una dirección. Por ejemplo para Argentina, corresponde al Partido.
Ver tabla de especificación por nivel.
Campo que se encuentra dentro del objeto mSuggest.		 64 String
level4 Corresponde al cuarto nivel administrativo de una dirección. Por ejemplo para Argentina, corresponde a Localidad.
Ver tabla de especificación por nivel.
Campo que se encuentra dentro del objeto mSuggest.		 64 String
level5 Corresponde al quinto nivel administrativo de una dirección. Por ejemplo para Argentina, corresponde a Barrio.
Ver tabla de especificación por nivel.
Campo que se encuentra dentro del objeto mSuggest.		 64 String
street Nombre de la calle o dirección completa. Puede incluir nombres de barrios cerrados, barrios zonales, rutas, alturas, piso, depto, referencias, nombres de puntos de interés, etc.
Campo que se encuentra dentro del objeto mSuggest.		 64 String
houseNumber Número de la dirección.
Campo que se encuentra dentro del objeto mSuggest.		 10 String
postalCode Código Postal de la dirección.
Campo que se encuentra dentro del objeto mSuggest.		 4 String
latitude Indica la latitud del centroide de la localidad.
Campo que se encuentra dentro del objeto mSuggest.		 10 String
longitude Indica la longitud del centroide de la localidad.
Campo que se encuentra dentro del objeto mSuggest.		 10 String
label Información del domicilio expresado en un solo campo.
Campo que se encuentra dentro del objeto mSuggest.		 – String
locationType Tipo de dirección. Ej: Calle, Avenida, Localidad, Barrio.
Campo que se encuentra dentro del objeto mSuggest.		 – String
maps Indica si la dirección fue relevada en el mapa.
Campo que se encuentra dentro del objeto mSuggest.
suggestedItem –
Campo que se encuentra dentro del objeto mSuggest.		 – String
maps Dibujo de localidad Disponible, Valores posibles: True, False.
Campo que se encuentra dentro del objeto mSuggest.		 – Boolean
geoType Tipo de georeferenciación. 2 String
merlinCustomValues Valores desarrollados por demanda del cliente o que se proveen opcionalmente. – Object
Mensaje JSON de respuesta
{
    "status": "SD",
    "statusReason": "SM",
    "transactionId": "366908db-966c-4b2d-b3f4-31718f65e35e",
    "mSuggest": [
        {
            "level1": "AR",
            "level2": "BUENOS AIRES",
            "level3": "JOSE CLEMENTE PAZ",
            "level4": "JOSE CLEMENTE PAZ",
            "level5": "",
            "street": "JUAN CRUZ VARELA",
            "houseNumber": "0",
            "postalCode": "1665",
            "latitude": "-34.514902",
            "longitude": "-58.789840",
            "label": "JUAN CRUZ VARELA, JOSE CLEMENTE PAZ, JOSE CLEMENTE PAZ, BUENOS AIRES",
            "locationType": "STREET",
            "suggestedItem": "",
            "maps": true,
            "geoType": 1,
            "merlinCustomValues": {}
        },
        {
            "level1": "AR",
            "level2": "BUENOS AIRES",
            "level3": "LUJAN",
            "level4": "JOSE MARIA JAUREGUI",
            "level5": "",
            "street": "PADRE VARELA",
            "houseNumber": "0",
            "postalCode": "6706",
            "latitude": "-34.561698",
            "longitude": "-59.183113",
            "label": "PADRE VARELA, JOSE MARIA JAUREGUI, LUJAN, BUENOS AIRES",
            "locationType": "STREET",
            "suggestedItem": "",
            "maps": true,
            "geoType": 1,
            "merlinCustomValues": {}
        },
        {
            "level1": "AR",
            "level2": "BUENOS AIRES",
            "level3": "PERGAMINO",
            "level4": "VILLA SAN JOSE",
            "level5": "BARRIO VILLA SAN JOSE",
            "street": "",
            "houseNumber": "0",
            "postalCode": "2743",
            "latitude": "-34.091800",
            "longitude": "-60.413000",
            "label": "BARRIO VILLA SAN JOSE, VILLA SAN JOSE, PERGAMINO, BUENOS AIRES",
            "locationType": "LEVEL5",
            "suggestedItem": "",
            "maps": false,
            "geoType": 13,
            "merlinCustomValues": {}
        },
        {
            "level1": "AR",
            "level2": "ENTRE RIOS",
            "level3": "PARANA",
            "level4": "PARANA",
            "level5": "",
            "street": "JOSE PEDRO VARELA",
            "houseNumber": "0",
            "postalCode": "3100",
            "latitude": "-31.738063",
            "longitude": "-60.505887",
            "label": "JOSE PEDRO VARELA, PARANA, PARANA, ENTRE RIOS",
            "locationType": "STREET",
            "suggestedItem": "",
            "maps": true,
            "geoType": 1,
            "merlinCustomValues": {}
        },
        {
            "level1": "AR",
            "level2": "CORDOBA",
            "level3": "CAPITAL",
            "level4": "CORDOBA",
            "level5": "",
            "street": "JOSE VARELA BERRO",
            "houseNumber": "0",
            "postalCode": "5008",
            "latitude": "-31.363889",
            "longitude": "-64.206643",
            "label": "JOSE VARELA BERRO, CORDOBA, CAPITAL, CORDOBA",
            "locationType": "STREET",
            "suggestedItem": "",
            "maps": true,
            "geoType": 1,
            "merlinCustomValues": {}
        },
        {
            "level1": "AR",
            "level2": "BUENOS AIRES",
            "level3": "FLORENCIO VARELA",
            "level4": "FLORENCIO VARELA",
            "level5": "",
            "street": "JOSE ENRIQUE RODO",
            "houseNumber": "0",
            "postalCode": "1888",
            "latitude": "-34.809650",
            "longitude": "-58.268131",
            "label": "JOSE ENRIQUE RODO, FLORENCIO VARELA, FLORENCIO VARELA, BUENOS AIRES",
            "locationType": "STREET",
            "suggestedItem": "",
            "maps": true,
            "geoType": 1,
            "merlinCustomValues": {}
        },
        {
            "level1": "AR",
            "level2": "BUENOS AIRES",
            "level3": "FLORENCIO VARELA",
            "level4": "FLORENCIO VARELA",
            "level5": "",
            "street": "JOSE MARMOL",
            "houseNumber": "0",
            "postalCode": "1888",
            "latitude": "-34.799275",
            "longitude": "-58.269996",
            "label": "JOSE MARMOL, FLORENCIO VARELA, FLORENCIO VARELA, BUENOS AIRES",
            "locationType": "STREET",
            "suggestedItem": "",
            "maps": true,
            "geoType": 1,
            "merlinCustomValues": {}
        },
        {
            "level1": "AR",
            "level2": "BUENOS AIRES",
            "level3": "FLORENCIO VARELA",
            "level4": "FLORENCIO VARELA",
            "level5": "",
            "street": "JOSE ROQUE PEREZ",
            "houseNumber": "0",
            "postalCode": "1888",
            "latitude": "-34.791309",
            "longitude": "-58.253723",
            "label": "JOSE ROQUE PEREZ, FLORENCIO VARELA, FLORENCIO VARELA, BUENOS AIRES",
            "locationType": "STREET",
            "suggestedItem": "",
            "maps": true,
            "geoType": 1,
            "merlinCustomValues": {}
        },
        {
            "level1": "AR",
            "level2": "BUENOS AIRES",
            "level3": "FLORENCIO VARELA",
            "level4": "FLORENCIO VARELA",
            "level5": "",
            "street": "DR JOSE VALENTIN GOMEZ",
            "houseNumber": "0",
            "postalCode": "1888",
            "latitude": "-34.810262",
            "longitude": "-58.285753",
            "label": "DR JOSE VALENTIN GOMEZ, FLORENCIO VARELA, FLORENCIO VARELA, BUENOS AIRES",
            "locationType": "STREET",
            "suggestedItem": "",
            "maps": true,
            "geoType": 1,
            "merlinCustomValues": {}
        },
        {
            "level1": "AR",
            "level2": "BUENOS AIRES",
            "level3": "FLORENCIO VARELA",
            "level4": "FLORENCIO VARELA",
            "level5": "",
            "street": "JOSE M DELGADO",
            "houseNumber": "0",
            "postalCode": "1888",
            "latitude": "-34.802250",
            "longitude": "-58.243613",
            "label": "JOSE M DELGADO, FLORENCIO VARELA, FLORENCIO VARELA, BUENOS AIRES",
            "locationType": "STREET",
            "suggestedItem": "",
            "maps": true,
            "geoType": 1,
            "merlinCustomValues": {}
        }
    ]
}
Tema Anterior
Volver a la Lección
Próximo Tema