Spectrum Global Address Validation - web_services - 23.1

Spectrum Web Services Guide

Product type
Software
Portfolio
Integrate
Product family
Spectrum
Product
Spectrum > Web Services
Version
23.1
Language
English
Product name
Spectrum Technology Platform
Title
Spectrum Web Services Guide
First publish date
2007
Last updated
2024-10-17
Published on
2024-10-17T00:33:46.811413

Spectrum Global Address Validation provides enhanced address standardization and validation. Global Address Validation combines data from multiple data sources into one database to provide the most extensive and accurate international addressing data possible.

Spectrum Global Address Validation analyzes and compares each input address to the Global Addressing database for the appropriate country. If needed, Global Address Validation corrects and formats the address in accordance with the postal standards for that country.

Standard address output consists of address lines which correspond to how the address would appear on an address label. City, state or province, postal code, and other data are also included in the standard address output.

Global AddressValidation is part of the Global Addressing Module.

Resource URL

JSON endpoint:

http://server:port/rest/GlobalAddressValidation/result.json

XML endpoint:

http://server:port/rest/GlobalAddressValidation/result.xml

Example with JSON Response

The following example requests a JSON response:

http://server:8080/rest/GlobalAddressValidation/result.json?​Data.AddressLine1=​103-113 STANLEY ST VICTORIA WEST MELBOURNE 3003 &Data.Country=AUS

The JSON returned by this request would be:

{"output_port": [{
   "AddressLine1": "103-113 Stanley Street",
   "AddressBlock1": "103-113 Stanley Street",
   "AddressBlock2": "West Melbourne VIC 3003",
   "City": "West Melbourne",
   "StateProvince": "VIC",
   "PostalCode": "3003",
   "Country": "Australia",
   "PrecisionCode": "S8HPNTSCZG",
   "ProcessedBy": "GAM",
   "MultimatchCount": "1",
   "HouseNumber": "103-113",
   "StreetName": "Stanley",
   "StreetType": "Street",
   "Confidence": "92",
   "Principality": "VIC",
   "MatchOnAllStreetFields": "true",
   "MatchOnStreetDirectional": "true",
   "City.Matched": "true",
   "CitySubdivision.Matched": "true",
   "StateProvince.Matched": "false",
   "StateProvinceSubdivision.Matched": "true",
   "StreetName.Matched": "true",
   "StreetType.Matched": "true",
   "Firmname.Matched": "true",
   "Housenumber.Matched": "true",
   "Postalcode.Matched": "true",
   "user_fields": []
}]}

Example with XML Response

The following example requests an XML response:

http://server:8080/rest/GlobalAddressValidation/result.xml?Data.AddressLine1=103-113 STANLEY ST VICTORIA WEST MELBOURNE 3003&Data.Country=AUS

The XML returned by this request would be:

<xml.GlobalAddressValidationResponse xmlns="http://www.precisely.com/spectrum/services/GlobalAddressValidation">
<output_port>
    <Row>
        <AddressLine1>103-113 Stanley Street</AddressLine1>
        <AddressBlock1>103-113 Stanley Street</AddressBlock1>
        <AddressBlock2>West Melbourne VIC 3003</AddressBlock2>
        <City>West Melbourne</City>
        <StateProvince>VIC</StateProvince>
        <PostalCode>3003</PostalCode>
        <Country>Australia</Country>
        <PrecisionCode>S8HPNTSCZG</PrecisionCode>
        <ProcessedBy>GAM</ProcessedBy>
        <MultimatchCount>1</MultimatchCount>
        <HouseNumber>103-113</HouseNumber>
        <StreetName>Stanley</StreetName>
        <StreetType>Street</StreetType>
        <Confidence>92</Confidence>
        <Principality>VIC</Principality>
        <MatchOnAllStreetFields>true</MatchOnAllStreetFields>
        <MatchOnStreetDirectional>true</MatchOnStreetDirectional>
        <City.Matched>true</City.Matched>
        <CitySubdivision.Matched>true</CitySubdivision.Matched>
        <StateProvince.Matched>false</StateProvince.Matched>
        <StateProvinceSubdivision.Matched>true
          </StateProvinceSubdivision.Matched>
        <StreetName.Matched>true</StreetName.Matched>
        <StreetType.Matched>true</StreetType.Matched>
        <Firmname.Matched>true</Firmname.Matched>
        <Housenumber.Matched>true</Housenumber.Matched>
        <Postalcode.Matched>true</Postalcode.Matched>
        <user_fields/>
    </Row>
 </output_port>
</xml.GlobalAddressValidationResponse>

JSON Example

http://server:8080/rest/GlobalAddressValidation/result.json

JSON POST request example:


{
"options":
{
      "Database_GAV":"JP_AU"
},
"input_port" : {
              "Input" : [
               {
       "AddressLine1": "103-113 STANLEY ST VICTORIA WEST MELBOURNE 3003",
       "Country": "AUS"
      },
      {
       "AddressLine1": "103-114 STANLEY ST VICTORIA WEST MELBOURNE 3004",
       "Country": "AUS"
      }       
              ]
}
}    

JSON POST response example:

{
    "output_port": [
        {
            "AddressLine1": "103-113 Stanley Street",
            "AddressBlock1": "103-113 Stanley Street",
            "AddressBlock2": "West Melbourne VIC 3003",
            "City": "West Melbourne",
            "StateProvince": "VIC",
            "PostalCode": "3003",
            "Country": "Australia",
            "PrecisionCode": "S8HPNTSCZG",
            "ProcessedBy": "GAM",
            "MultimatchCount": "1",
            "HouseNumber": "103-113",
            "StreetName": "Stanley",
            "StreetType": "Street",
            "Confidence": "92",
            "Principality": "VIC",
            "MatchOnAllStreetFields": "true",
            "MatchOnStreetDirectional": "true",
            "City.Matched": "true",
            "CitySubdivision.Matched": "true",
            "StateProvince.Matched": "false",
            "StateProvinceSubdivision.Matched": "true",
            "StreetName.Matched": "true",
            "StreetType.Matched": "true",
            "Firmname.Matched": "true",
            "Housenumber.Matched": "true",
            "Postalcode.Matched": "true",
            "user_fields": []
        },
        {
            "AddressLine1": "103-114 Stanley Street",
            "AddressBlock1": "103-114 Stanley Street",
            "AddressBlock2": "West Melbourne VIC 3003",
            "City": "West Melbourne",
            "StateProvince": "VIC",
            "StateProvinceSubdivision": "Melbourne",
            "PostalCode": "3003",
            "Country": "Australia",
            "PrecisionCode": "S5HPNTSC-A",
            "ProcessedBy": "GAM",
            "MultimatchCount": "1",
            "HouseNumber": "103-114",
            "StreetName": "Stanley",
            "StreetType": "Street",
            "Confidence": "80",
            "Principality": "VIC",
            "MatchOnAllStreetFields": "true",
            "MatchOnStreetDirectional": "true",
            "City.Matched": "true",
            "CitySubdivision.Matched": "true",
            "StateProvince.Matched": "false",
            "StateProvinceSubdivision.Matched": "true",
            "StreetName.Matched": "true",
            "StreetType.Matched": "true",
            "Firmname.Matched": "true",
            "Housenumber.Matched": "true",
            "Postalcode.Matched": "false",
            "user_fields": []
        }
    ]
}    

XML Example

http://server:8080/rest/GlobalAddressValidation/result.xml
XML POST request example:
<GlobalAddressValidationRequest xmlns:gav="http://www.precisely.com/spectrum/services/GlobalAddressValidation">
<options>
	<Database_GAV>JP_AU</Database_GAV>
</options>	
<gav:input_port>
    <gav:Input>
         <gav:AddressLine1>103-113 STANLEY ST VICTORIA WEST MELBOURNE 3003
         </gav:AddressLine1>
         <gav:Country>AUS</gav:Country>
         <gav:user_fields>
             <gav:user_field>
                 <gav:name>id</gav:name>
                 <gav:value>1</gav:value>
             </gav:user_field>
         </gav:user_fields>

     </gav:Input>
     <gav:Input>
          <gav:AddressLine1>103-113 STANLEY ST VICTORIA WEST MELBOURNE 3003
          </gav:AddressLine1>
          <gav:Country>AUS</gav:Country>
          <gav:user_fields>
              <gav:user_field>
                  <gav:name>id</gav:name>
                  <gav:value>2</gav:value>
              </gav:user_field>
         </gav:user_fields>
     </gav:Input>
</gav:input_port>
</GlobalAddressValidationRequest>
XML POST response example:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xml.GlobalAddressValidationResponse xmlns="http://www.precisely.com/spectrum/services/GlobalAddressValidation">
    <output_port>
        <Row>
            <AddressLine1>103-113 Stanley Street</AddressLine1>
            <AddressBlock1>103-113 Stanley Street</AddressBlock1>
            <AddressBlock2>West Melbourne VIC 3003</AddressBlock2>
            <City>West Melbourne</City>
            <StateProvince>VIC</StateProvince>
            <PostalCode>3003</PostalCode>
            <Country>Australia</Country>
            <PrecisionCode>S8HPNTSCZG</PrecisionCode>
            <ProcessedBy>GAM</ProcessedBy>
            <MultimatchCount>1</MultimatchCount>
            <HouseNumber>103-113</HouseNumber>
            <StreetName>Stanley</StreetName>
            <StreetType>Street</StreetType>
            <Confidence>92</Confidence>
            <Principality>VIC</Principality>
            <MatchOnAllStreetFields>true</MatchOnAllStreetFields>
            <MatchOnStreetDirectional>true</MatchOnStreetDirectional>
            <City.Matched>true</City.Matched>
            <CitySubdivision.Matched>true</CitySubdivision.Matched>
            <StateProvince.Matched>false</StateProvince.Matched>
            <StateProvinceSubdivision.Matched>true
            </StateProvinceSubdivision.Matched>
            <StreetName.Matched>true</StreetName.Matched>
            <StreetType.Matched>true</StreetType.Matched>
            <Firmname.Matched>true</Firmname.Matched>
            <Housenumber.Matched>true</Housenumber.Matched>
            <Postalcode.Matched>true</Postalcode.Matched>
            <user_fields>
                <user_field>
                    <name>id</name>
                    <value>1</value>
                </user_field>
            </user_fields>
        </Row>
        <Row>
            <AddressLine1>103-113 Stanley Street</AddressLine1>
            <AddressBlock1>103-113 Stanley Street</AddressBlock1>
            <AddressBlock2>West Melbourne VIC 3003</AddressBlock2>
            <City>West Melbourne</City>
            <StateProvince>VIC</StateProvince>
            <PostalCode>3003</PostalCode>
            <Country>Australia</Country>
            <PrecisionCode>S8HPNTSCZG</PrecisionCode>
            <ProcessedBy>GAM</ProcessedBy>
            <MultimatchCount>1</MultimatchCount>
            <HouseNumber>103-113</HouseNumber>
            <StreetName>Stanley</StreetName>
            <StreetType>Street</StreetType>
            <Confidence>92</Confidence>
            <Principality>VIC</Principality>
            <MatchOnAllStreetFields>true</MatchOnAllStreetFields>
            <MatchOnStreetDirectional>true</MatchOnStreetDirectional>
            <City.Matched>true</City.Matched>
            <CitySubdivision.Matched>true</CitySubdivision.Matched>
            <StateProvince.Matched>false</StateProvince.Matched>
            <StateProvinceSubdivision.Matched>true
            </StateProvinceSubdivision.Matched>
            <StreetName.Matched>true</StreetName.Matched>
            <StreetType.Matched>true</StreetType.Matched>
            <Firmname.Matched>true</Firmname.Matched>
            <Housenumber.Matched>true</Housenumber.Matched>
            <Postalcode.Matched>true</Postalcode.Matched>
            <user_fields>
                <user_field>
                    <name>id</name>
                    <value>2</value>
                </user_field>
            </user_fields>
        </Row>
    </output_port>
</xml.GlobalAddressValidationResponse>