GetCandidateAddressesLoqate

GetCandidateAddressesLoqate devuelve una lista de direcciones que se consideran cruces (coincidencias) para una dirección dada. GetCandidateAddressesLoqate devuelve direcciones de candidatos solo si la dirección de entrada coincide con múltiples direcciones de la base de datos postales. Si la dirección de entrada coincide solo con una dirección de la base de datos postales, no se devuelven datos de dirección. Se requiere el campo de entrada Country (País). Si este campo está en blanco, no se obtendrán datos de salida.

Nota: De forma predeterminada, GetCandidateAddressesLoqate no establece cruces con números de casa individuales, sino que utiliza rangos de números de casas para cada calle. Después de que GetCandidateAddressesLoqate determina el nombre de la calle, la ciudad, el estado o la provincia y el código postal, verifica que el número de casa de entrada corresponda a uno de los rangos de números de casas dados para el nombre de calle coincidente. El mismo tipo de lógica se aplica a los números de unidades.

GetCandidateAddressesLoqate forma parte del módulo Universal Addressing.

URL del recurso

Extremo del elemento JSON:

http://server:port/rest/GetCandidateAddressesLoqate/results.json

Extremo del XML:

http://server:port/rest/GetCandidateAddressesLoqate/results.xml

Ejemplo con respuesta JSON

El siguiente ejemplo solicita una respuesta JSON:

http://myserver:8080/rest/GetCandidateAddressesLoqate/results.json?Data.AddressLine1=PO+Box+1&Data.City=New+York&Data.StateProvince=NY

El elemento JSON devuelto por esta solicitud sería:

Nota: En este ejemplo se eliminaron los elementos de respuesta vacíos. Solo se muestran las dos primeras direcciones del candidato.

{"output_port": [
      {
      "ProcessedBy": "LOQATE",
      "AddressLine1": "PO Box 101",
      "City": "New York Mls",
      "StateProvince": "NY",
      "PostalCode": "13417-0101",
      "Country": "USA",
      "PostalCode.AddOn": "0101",
      "user_fields": []
   },
      {
      "ProcessedBy": "LOQATE",
      "AddressLine1": "PO Box 102",
      "City": "New York Mls",
      "StateProvince": "NY",
      "PostalCode": "13417-0102",
      "Country": "USA",
      "PostalCode.AddOn": "0102",
      "user_fields": []
   }
]}

Ejemplo con respuesta XML

El siguiente ejemplo solicita una respuesta XML:

http://myserver:8080/rest/GetCandidateAddressesLoqate/results.xml?Data.AddressLine1=PO+Box+1&Data.City=New+York&Data.StateProvince=NY

El elemento XML devuelto por esta solicitud sería:

Nota: En este ejemplo se eliminaron los elementos de respuesta vacíos. Solo se muestran las dos primeras direcciones del candidato.

<ns2:xml.GetCandidateAddressesLoqateResponse
xmlns:ns2="http://www.pb.com/spectrum/services/GetCandidateAddressesLoqate">
   <ns2:output_port>
      <ns2:Address>
         <ns2:ProcessedBy>LOQATE</ns2:ProcessedBy>
         <ns2:AddressLine1>PO Box 101</ns2:AddressLine1>
         <ns2:City>New York Mls</ns2:City>
         <ns2:StateProvince>NY</ns2:StateProvince>
         <ns2:PostalCode>13417-0101</ns2:PostalCode>
         <ns2:PostalCode.AddOn>0101</ns2:PostalCode.AddOn>
         <ns2:Country>USA</ns2:Country>
      </ns2:Address>
      <ns2:Address>
         <ns2:ProcessedBy>LOQATE</ns2:ProcessedBy>
         <ns2:AddressLine1>PO Box 102</ns2:AddressLine1>
         <ns2:City>New York Mls</ns2:City>
         <ns2:StateProvince>NY</ns2:StateProvince>
         <ns2:PostalCode>13417-0102</ns2:PostalCode>
         <ns2:PostalCode.AddOn>0102</ns2:PostalCode.AddOn>
         <ns2:Country>USA</ns2:Country>
      </ns2:Address>
   </ns2:output_port>
</ns2:xml.GetCandidateAddressesLoqateResponse>