GeoTypeAheadUSCAN

Resource URL

JSON endpoint:

https://OnDemandServer/rest/GeoTypeAheadUSCAN/results.json

XML endpoint:

https://OnDemandServer/rest/GeoTypeAheadUSCAN/results.xml

For a list of Spectrum OnDemand servers, see Connecting to Spectrum OnDemand Servers.

Example with JSON Response

The following example requests a JSON response:

https://spectrum.precisely.com/rest/GeoTypeAheadUSCAN/results.json?Data.AddressLine1=20 w 34 &Data.Latitude=40.7486589707895&Data.Longitude=-73.98580641773391

The JSON returned by this request would be:

                {
    "Output": [
        {
            "AddressLine1": "20 W 34th St",
            "StateProvince": "NY",
            "PostalCode": "10118",
            "City": "New York",
            "ProcessedBy": "GGM",
            "InstanceKey": "ACUjMTMTY0MjQyMjcyMDc2OAMT01Mz",
            "FormattedAddress": "20 W 34th St, New York, NY 10118",
            "RangeCount": "1",
            "Ranges": [
                {
                    "Range": "20",
                    "FormattedRangeAddress": "20 W 34th St, New York, NY 10118",
                    "UnitCount": "2",
                    "UnitsInfo": [
                       

{                             "UnitInfo": "Frnt 1",                             "FormattedUnitAddress": "20 W 34th St, Frnt 1, New York, NY 10118"                         }
,
                       

{                             "UnitInfo": "Frnt 2",                             "FormattedUnitAddress": "20 W 34th St, Frnt 2, New York, NY 10118"                         }
                    ]
                }
            ],
            "Country": "USA",
            "user_fields": []
        },
        {
            "AddressLine1": "20 W 34th St",
            "StateProvince": "NJ",
            "PostalCode": "07002",
            "City": "Bayonne",
            "ProcessedBy": "GGM",
            "InstanceKey": "ACUjMTMTY0MjQyMjcyMDc2OAMT01Mz",
            "FormattedAddress": "20 W 34th St, Bayonne, NJ 07002",
            "RangeCount": "1",
            "Ranges": [
                {
                    "Range": "20",
                    "FormattedRangeAddress": "20 W 34th St, Bayonne, NJ 07002",
                    "UnitCount": "5",
                    "UnitsInfo": [
                       

{                             "UnitInfo": "#22",                             "FormattedUnitAddress": "20 W 34th St, #22, Bayonne, NJ 07002"                         }
,
                       

{                             "UnitInfo": "Apt 2",                             "FormattedUnitAddress": "20 W 34th St, Apt 2, Bayonne, NJ 07002"                         }
,
                       

{                             "UnitInfo": "Apt 5",                             "FormattedUnitAddress": "20 W 34th St, Apt 5, Bayonne, NJ 07002"                         }
,
                       

{                             "UnitInfo": "Apt 7",                             "FormattedUnitAddress": "20 W 34th St, Apt 7, Bayonne, NJ 07002"                         }
,
                       

{                             "UnitInfo": "Apt G",                             "FormattedUnitAddress": "20 W 34th St, Apt G, Bayonne, NJ 07002"                         }
                    ]
                }
            ],
            "Country": "USA",
            "user_fields": []
        }
    ]
}

Example with XML Response

The following example requests an XML response:

https://spectrum.precisely.com/rest/GeoTypeAheadUSCAN/results.xml?Data.AddressLine1=20 w 34 &Data.Latitude=40.7486589707895&Data.Longitude=-73.98580641773391

The XML returned by this request would be:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xml.GeoTypeAheadUSCANResponse xmlns="http://www.pb.com/spectrum/services/GeoTypeAheadUSCAN">
    <Output>
        <Row>
            <AddressLine1>20 W 34th St</AddressLine1>
            <StateProvince>NY</StateProvince>
            <PostalCode>10118</PostalCode>
            <City>New York</City>
            <ProcessedBy>GGM</ProcessedBy>
            <InstanceKey>ACUjMDMTY0MjQyMjg2Njc3NgMD01Mj</InstanceKey>
            <FormattedAddress>20 W 34th St, New York, NY 10118</FormattedAddress>
            <RangeCount>1</RangeCount>
            <Ranges>
                <Range>
                    <Range>20</Range>
                    <FormattedRangeAddress>20 W 34th St, New York, NY 10118</FormattedRangeAddress>
                    <UnitCount>2</UnitCount>
                    <UnitsInfo>
                        <UnitInfo>
                            <UnitInfo>Frnt 1</UnitInfo>
                            <FormattedUnitAddress>20 W 34th St, Frnt 1, New York, NY 10118</FormattedUnitAddress>
                        </UnitInfo>
                        <UnitInfo>
                            <UnitInfo>Frnt 2</UnitInfo>
                            <FormattedUnitAddress>20 W 34th St, Frnt 2, New York, NY 10118</FormattedUnitAddress>
                        </UnitInfo>
                    </UnitsInfo>
                </Range>
            </Ranges>
            <Country>USA</Country>
            <user_fields/>
        </Row>
        <Row>
            <AddressLine1>20 W 34th St</AddressLine1>
            <StateProvince>NJ</StateProvince>
            <PostalCode>07002</PostalCode>
            <City>Bayonne</City>
            <ProcessedBy>GGM</ProcessedBy>
            <InstanceKey>ACUjMDMTY0MjQyMjg2Njc3NgMD01Mj</InstanceKey>
            <FormattedAddress>20 W 34th St, Bayonne, NJ 07002</FormattedAddress>
            <RangeCount>1</RangeCount>
            <Ranges>
                <Range>
                    <Range>20</Range>
                    <FormattedRangeAddress>20 W 34th St, Bayonne, NJ 07002</FormattedRangeAddress>
                    <UnitCount>5</UnitCount>
                    <UnitsInfo>
                        <UnitInfo>
                            <UnitInfo>#22</UnitInfo>
                            <FormattedUnitAddress>20 W 34th St, #22, Bayonne, NJ 07002</FormattedUnitAddress>
                        </UnitInfo>
                        <UnitInfo>
                            <UnitInfo>Apt 2</UnitInfo>
                            <FormattedUnitAddress>20 W 34th St, Apt 2, Bayonne, NJ 07002</FormattedUnitAddress>
                        </UnitInfo>
                        <UnitInfo>
                            <UnitInfo>Apt 5</UnitInfo>
                            <FormattedUnitAddress>20 W 34th St, Apt 5, Bayonne, NJ 07002</FormattedUnitAddress>
                        </UnitInfo>
                        <UnitInfo>
                            <UnitInfo>Apt 7</UnitInfo>
                            <FormattedUnitAddress>20 W 34th St, Apt 7, Bayonne, NJ 07002</FormattedUnitAddress>
                        </UnitInfo>
                        <UnitInfo>
                            <UnitInfo>Apt G</UnitInfo>
                            <FormattedUnitAddress>20 W 34th St, Apt G, Bayonne, NJ 07002</FormattedUnitAddress>
                        </UnitInfo>
                    </UnitsInfo>
                </Range>
            </Ranges>
            <Country>USA</Country>
            <user_fields/>
        </Row>
    </Output>
</xml.GeoTypeAheadUSCANResponse>