Get Candidate Addresses - Spectrum_OnDemand - addressing - web_services - 23.1

Guía de servicios web de Spectrum

Product type
Portfolio
Integrate
Product family
Product
Spectrum > Web Services
Version
23.1
Language
Español (México)
Product name
Spectrum Technology Platform
Title
Guía de servicios web de Spectrum
First publish date
2007
ft:lastEdition
2024-02-07
ft:lastPublication
2024-02-07T18:09:34.894393

Get Candidate Addresses devuelve una lista de direcciones que se consideran cruces (coincidencias) para una dirección dada. Get Candidate Addresses 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.

Para direcciones fuera de Estados Unidos y Canadá, pueden observarse contradicciones entre los múltiples cruces devueltos por Validate Address y los resultados correspondientes a esas mismas direcciones devueltos por Get Candidate Addresses. Si observa resultados contradictorios, probablemente se deba a que el ajuste de rendimiento de Validate Address está configurado con un valor que no es 100. Para obtener resultados uniformes entre Get Candidate Addresses y Validate Address, configure la opción de ajuste de rendimiento con el valor 100.

Nota: De forma predeterminada, Get Candidate Addresses 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 Get Candidate Addresses 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. Si usted desea determinar que un número de casa individual es válido, debe utilizar la opción de procesamiento de validación de punto de entrega (Delivery Point Validation, DPV) de Validate Address. El procesamiento DPV solo está disponible para direcciones de Estados Unidos.

El codificador de Canadá incluye una rutina de búsqueda inversa que toma como entrada un código postal específico y arroja la información de calle almacenada en la base de datos para ese código postal. Para usar esta función no ingrese ningún dato salvo un código postal de Canadá en el campo PostalCode. Consulte el segundo ejemplo para ver los resultados obtenidos con un código postal de ejemplo.

Get Candidate Addresses forma parte de Spectrum Universal Address.

Ejemplo de dirección de EE.UU.

AddressLine1 (Línea de dirección 1):

PO Box 1 City: NY State: NY

Vista previa de la salida:

Nombre de campo Registro de salida 1 Registro de salida 2
AddressLine1 PO Box 1 PO Box 1
City Nueva York Nueva York
País USA USA
HouseNumberHigh 60 9
HouseNumberLow 1 1
HouseNumberParity B B
MatchLevel A A
PostalCode 10002 10008
PostalCode.AddOn 0001 0001
ProcessedBy USA USA
RecordType PostOfficeBox PostOfficeBox
RecordType.Default
StateProvince NY NY
UnitNumberParity

Ejemplo de dirección de Canadá

PostalCode (Código postal):

A1A1A1

Vista previa de la salida:

Nombre de campo Registro de salida 1 Registro de salida 2
AddressLine1 LOWER BATTERY RD LOWER BATTERY RD
City ST. JOHN'S ST. JOHN'S
País CAN CAN
HouseNumberHigh 000003 000004 A
HouseNumberLow 000001 000002
HouseNumberParity O E
MatchLevel A A
PostalCode A1A1A1 A1A1A1
ProcessedBy CAN CAN
RecordType Normal Normal
StateProvince NL NL

URL del recurso

Extremo del elemento JSON:

http://server:port/rest/GetCandidateAddresses/results.json
https://OnDemandServer/rest/GetCandidateAddresses/results.json

Extremo del XML:

http://server:port/rest/GetCandidateAddresses/results.xml
https://OnDemandServer/rest/GetCandidateAddresses/results.xml
http://server:port/soap/GetCandidateAddresses
https://OnDemandServer/soap/GetCandidateAddresses

Para acceder a una lista de los servidores Spectrum Technology Platform, consulte Conexión a servidores.

Ejemplo con respuesta JSON

El siguiente ejemplo solicita una respuesta JSON:

http://myserver:8080/rest/GetCandidateAddresses/results.json?​Data.AddressLine1=P.O.+Box+1&Data.City=New+York&Data.StateProvince=NY
https://spectrum.precisely.com/rest/GetCandidateAddresses/results.json?​Data.AddressLine1=P.O.+Box+1&Data.City=New+York&Data.StateProvince=NY

El elemento JSON devuelto por esta solicitud sería:

{"output_port": [       {       "ProcessedBy": "USA",       "RecordType": "PostOfficeBox",       "MatchLevel": "A",       "AddressLine1": "PO Box 1",       "HouseNumberLow": "1",       "HouseNumberHigh": "60",       "HouseNumberParity": "B",       "UnitNumberLow": "",       "UnitNumberHigh": "",       "UnitNumberParity": " ",       "FirmName": "",       "City": "New York",       "USUrbanName": "",       "StateProvince": "NY",       "PostalCode": "10002",       "Country": "USA",       "PostalCode.AddOn": "0001",       "user_fields": []    },       {       "ProcessedBy": "USA",       "RecordType": "PostOfficeBox",       "MatchLevel": "A",       "AddressLine1": "PO Box 1",       "HouseNumberLow": "1",       "HouseNumberHigh": "9",       "HouseNumberParity": "B",       "UnitNumberLow": "",       "UnitNumberHigh": "",       "UnitNumberParity": " ",       "FirmName": "",       "City": "New York",       "USUrbanName": "",       "StateProvince": "NY",       "PostalCode": "10008",       "Country": "USA",       "PostalCode.AddOn": "0001",       "user_fields": []    },       {       "ProcessedBy": "USA",       "RecordType": "PostOfficeBox",       "MatchLevel": "A",       "AddressLine1": "PO Box 1",       "HouseNumberLow": "1",       "HouseNumberHigh": "60",       "HouseNumberParity": "B",       "UnitNumberLow": "",       "UnitNumberHigh": "",       "UnitNumberParity": " ",       "FirmName": "",       "City": "New York",       "USUrbanName": "",       "StateProvince": "NY",       "PostalCode": "10009",       "Country": "USA",       "PostalCode.AddOn": "0001",       "user_fields": []    } ]}

Ejemplo con respuesta XML

El siguiente ejemplo solicita una respuesta XML:

http://myserver:8080/rest/GetCandidateAddresses/results.xml?​Data.AddressLine1=P.O.+Box+1&Data.City=New+York&Data.StateProvince=NY
https://spectrum.precisely.com/rest/GetCandidateAddresses/results.xml?​Data.AddressLine1=P.O.+Box+1&Data.City=New+York&Data.StateProvince=NY

El elemento XML devuelto por esta solicitud sería:

<ns2:xml.GetCandidateAddressesResponse ​xmlns:ns2="http://www.pb.com/spectrum/services/GetCandidateAddresses">    <ns2:output_port>       <ns2:Address>          <ns2:ProcessedBy>USA</ns2:ProcessedBy>          <ns2:RecordType>PostOfficeBox</ns2:RecordType>          <ns2:MatchLevel>A</ns2:MatchLevel>          <ns2:AddressLine1>PO Box 1</ns2:AddressLine1>          <ns2:HouseNumberLow>1</ns2:HouseNumberLow>          <ns2:HouseNumberHigh>60</ns2:HouseNumberHigh>          <ns2:HouseNumberParity>B</ns2:HouseNumberParity>          <ns2:UnitNumberLow/>          <ns2:UnitNumberHigh/>          <ns2:UnitNumberParity></ns2:UnitNumberParity>          <ns2:FirmName/>          <ns2:City>New York</ns2:City>          <ns2:USUrbanName/>          <ns2:StateProvince>NY</ns2:StateProvince>          <ns2:PostalCode>10002</ns2:PostalCode>          <ns2:PostalCode.AddOn>0001</ns2:PostalCode.AddOn>          <ns2:Country>USA</ns2:Country>          <ns2:user_fields/>       </ns2:Address>       <ns2:Address>          <ns2:ProcessedBy>USA</ns2:ProcessedBy>          <ns2:RecordType>PostOfficeBox</ns2:RecordType>          <ns2:MatchLevel>A</ns2:MatchLevel>          <ns2:AddressLine1>PO Box 1</ns2:AddressLine1>          <ns2:HouseNumberLow>1</ns2:HouseNumberLow>          <ns2:HouseNumberHigh>9</ns2:HouseNumberHigh>          <ns2:HouseNumberParity>B</ns2:HouseNumberParity>          <ns2:UnitNumberLow/>          <ns2:UnitNumberHigh/>          <ns2:UnitNumberParity></ns2:UnitNumberParity>          <ns2:FirmName/>          <ns2:City>New York</ns2:City>          <ns2:USUrbanName/>          <ns2:StateProvince>NY</ns2:StateProvince>          <ns2:PostalCode>10008</ns2:PostalCode>          <ns2:PostalCode.AddOn>0001</ns2:PostalCode.AddOn>          <ns2:Country>USA</ns2:Country>          <ns2:user_fields/>       </ns2:Address>    </ns2:output_port> </ns2:xml.GetCandidateAddressesResponse>

Ejemplo

A continuación se muestra una solicitud SOAP:

<soapenv:Envelope 	xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 	xmlns:get="http://www.pb.com/spectrum/services/GetCandidateAddresses"> 	<soapenv:Header/> 	<soapenv:Body> 		<get:GetCandidateAddressesRequest> 			<get:input_port> 				<get:Address> 					<!--Optional:--> 					<get:AddressLine1>P.O. Box 1</get:AddressLine1> 					<!--Optional:--> 					<get:AddressLine2></get:AddressLine2> 					<!--Optional:--> 					<get:AddressLine3></get:AddressLine3> 					<!--Optional:--> 					<get:AddressLine4></get:AddressLine4> 					<!--Optional:--> 					<get:AddressLine5></get:AddressLine5> 					<!--Optional:--> 					<get:City>New York</get:City> 					<!--Optional:--> 					<get:StateProvince>NY</get:StateProvince> 					<!--Optional:--> 					<get:PostalCode></get:PostalCode> 					<!--Optional:--> 					<get:Country></get:Country> 					<!--Optional:--> 					<get:FirmName></get:FirmName> 					<!--Optional:--> 					<get:USUrbanName></get:USUrbanName> 					<!--Optional:--> 					<get:user_fields> 						<get:user_field> 							<get:name></get:name> 							<get:value></get:value> 						</get:user_field> 					</get:user_fields> 				</get:Address> 			</get:input_port> 		</get:GetCandidateAddressesRequest> 	</soapenv:Body> </soapenv:Envelope> 

Esta sería la respuesta:

Nota: En este ejemplo se eliminaron los elementos de respuesta vacíos. Solo se muestran las dos primeras direcciones del candidato.
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">    <soap:Body>       <ns3:GetCandidateAddressesResponse xmlns:ns2="www.pb.com/" ​xmlns:ns3="http://www.pb.com/spectrum/services/GetCandidateAddresses">          <ns3:output_port>             <ns3:Address>                <ns3:ProcessedBy>USA</ns3:ProcessedBy>                <ns3:RecordType>PostOfficeBox</ns3:RecordType>                <ns3:MatchLevel>A</ns3:MatchLevel>                <ns3:AddressLine1>PO Box 1</ns3:AddressLine1>                <ns3:HouseNumberLow>1</ns3:HouseNumberLow>                <ns3:HouseNumberHigh>60</ns3:HouseNumberHigh>                <ns3:HouseNumberParity>B</ns3:HouseNumberParity>                <ns3:City>New York</ns3:City>                <ns3:StateProvince>NY</ns3:StateProvince>                <ns3:PostalCode>10002</ns3:PostalCode>                <ns3:PostalCode.AddOn>0001</ns3:PostalCode.AddOn>                <ns3:Country>USA</ns3:Country>             </ns3:Address>             <ns3:Address>                <ns3:ProcessedBy>USA</ns3:ProcessedBy>                <ns3:RecordType>PostOfficeBox</ns3:RecordType>                <ns3:MatchLevel>A</ns3:MatchLevel>                <ns3:AddressLine1>PO Box 1</ns3:AddressLine1>                <ns3:HouseNumberLow>1</ns3:HouseNumberLow>                <ns3:HouseNumberHigh>9</ns3:HouseNumberHigh>                <ns3:HouseNumberParity>B</ns3:HouseNumberParity>                <ns3:City>New York</ns3:City>                <ns3:StateProvince>NY</ns3:StateProvince>                <ns3:PostalCode>10008</ns3:PostalCode>                <ns3:PostalCode.AddOn>0001</ns3:PostalCode.AddOn>                <ns3:Country>USA</ns3:Country>             </ns3:Address>          </ns3:output_port>       </ns3:GetCandidateAddressesResponse>    </soap:Body> </soap:Envelope>