API de servicios

Tema Anterior
Próximo Tema

Consulta de Maestros Calles

API de servicios Servicios JSON 2.5 Consulta de Maestros Calles

Consulta de Maestros Calles

 

Servicio de Consulta de Maestro Calles (catalog streetquery)

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

  • level1: Prefijo de país (AR)
  • level2: Deberá completarse con la provincia
  • level3: Tercer nivel administrativo de una dirección
  • level4: Deberá completarse con la Localidad
  • street: Deberá completarse con la vialidad que se desea consultar

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/catalog/streetquery

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
level1 Corresponde al primer nivel (País) administrativo de una dirección. 2 String
level2 Corresponde al segundo nivel administrativo de una dirección. Por ejemplo para Argentina, corresponde a Provincia. 64 String
level3 Corresponde al tercer nivel administrativo de una dirección. Por ejemplo para Argentina, corresponde al Partido. 64 String
level4 Corresponde al cuarto nivel administrativo de una dirección. Por ejemplo para Argentina, corresponde a Localidad. 64 String
listSegments Flag tipo boolean que habilita el detalle de segmentos que componen la calle. Por ejemplo: el valor true para habilitar el listado de tramos de la calle. 4 Booleano
street Indicar la vialidad que se desea consultar. 64 String
postalCode Puede no completarse si se informa el level4.
customAdapterKeys ID de acceso de cliente. 64 String
Mensaje JSON de petición
{
  "level1": "",
  "level2": "RIO NEGRO",
  "level3": "",
  "level4": "VIEDMA",
  "listSegments": false,
  "street": "SAN MARTIN"
}
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
totalRecords
mSuggest Son los datos de nombre normalizado.. – –
level1 Corresponde al primer nivel (País) administrativo de una dirección. 2 String
level2 Corresponde al segundo nivel administrativo de una dirección. Por ejemplo para Argentina, corresponde a Provincia. 64 String
level3 Corresponde al tercer nivel administrativo de una dirección. Por ejemplo para Argentina, corresponde al Partido. 64 String
level4 Corresponde al cuarto nivel administrativo de una dirección. Por ejemplo para Argentina, corresponde a Localidad. 64 String
level5 Corresponde al quinto nivel administrativo de una dirección. Por ejemplo para Argentina, corresponde a Localidad. 64 String
suggestedItem Indica calle, barrio zonal, barrio privado, lugar o punto de interés que se sugiere. 64 String
postalCode Código postal de la dirección informada. 4 String
streetNumberFrom Altura inicial de la calle informada. 15 String
streetNumberTo Altura final de la calle informada. 15 String
merlinCustomValues Valores desarrollados por demanda del cliente o que se proveen opcionalmente. – Object
segmentList Retornará N-veces la lista de tramos correspondiente a la calle. – –
synonymous Informa algún sinónimo que posee la calle. 64 String
Mensaje JSON de respuesta
{
    "status": "CO",
    "statusReason": "SM",
    "transactionId": "9bf467d4-3ed4-4467-9ac9-ac8511554125",
    "totalRecords": 1,
    "mSuggest": [
        {
            "level1": "AR",
            "level2": "RIO NEGRO",
            "level3": "ADOLFO ALSINA",
            "level4": "VIEDMA",
            "level5": "",
            "suggestedItem": "SAN MARTIN",
            "postalCode": "8500",
            "streetNumberFrom": "0",
            "streetNumberTo": "900",
            "merlinCustomValues": {
            },
            "segmentList": [],
            "synonymous": ""
        }
    ]
}
Tema Anterior
Volver a la Lección
Próximo Tema