POST Location/AddressLookup

The Address Lookup service processes multiple addresses in a single batch request

Request Information

Parameters

Name	Description	Additional information
request	Batch request containing multiple addresses to process	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "requestId": "sample string 1",
  "addresses": [
    {
      "locId": "sample string 1",
      "address": "sample string 2"
    },
    {
      "locId": "sample string 1",
      "address": "sample string 2"
    },
    {
      "locId": "sample string 1",
      "address": "sample string 2"
    }
  ],
  "allMatchLevels": true,
  "resetCache": true,
  "apiIdentifier": "sample string 4",
  "user": "sample string 5"
}

text/html

Sample:

{"requestId":"sample string 1","addresses":[{"locId":"sample string 1","address":"sample string 2"},{"locId":"sample string 1","address":"sample string 2"},{"locId":"sample string 1","address":"sample string 2"}],"allMatchLevels":true,"resetCache":true,"apiIdentifier":"sample string 4","user":"sample string 5"}

application/xml, text/xml

Sample:

<AddressLookupRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <APIIdentifier>sample string 4</APIIdentifier>
  <User>sample string 5</User>
  <RequestId>sample string 1</RequestId>
  <Addresses>
    <AddressItem>
      <LocId>sample string 1</LocId>
      <Address>sample string 2</Address>
    </AddressItem>
    <AddressItem>
      <LocId>sample string 1</LocId>
      <Address>sample string 2</Address>
    </AddressItem>
    <AddressItem>
      <LocId>sample string 1</LocId>
      <Address>sample string 2</Address>
    </AddressItem>
  </Addresses>
  <AllMatchLevels>true</AllMatchLevels>
  <ResetCache>true</ResetCache>
</AddressLookupRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AddressLookupRequest'.

Response Information

Batch response with results for each address processed

Response body formats

application/json, text/json

Sample:

{
  "requestId": "sample string 1",
  "results": [
    {
      "locId": "sample string 1",
      "originalAddress": "sample string 2",
      "locations": [
        {
          "formattedAddress": "sample string 1",
          "locationMatchType": "sample string 2",
          "matchLevel": "sample string 3",
          "addressMatch": true,
          "streetAddress1": "sample string 5",
          "streetAddress2": "sample string 6",
          "city": "sample string 7",
          "zipCode": "sample string 8",
          "county": "sample string 9",
          "state": "sample string 10",
          "country": "sample string 11",
          "latitude": "sample string 12",
          "longitude": "sample string 13"
        },
        {
          "formattedAddress": "sample string 1",
          "locationMatchType": "sample string 2",
          "matchLevel": "sample string 3",
          "addressMatch": true,
          "streetAddress1": "sample string 5",
          "streetAddress2": "sample string 6",
          "city": "sample string 7",
          "zipCode": "sample string 8",
          "county": "sample string 9",
          "state": "sample string 10",
          "country": "sample string 11",
          "latitude": "sample string 12",
          "longitude": "sample string 13"
        },
        {
          "formattedAddress": "sample string 1",
          "locationMatchType": "sample string 2",
          "matchLevel": "sample string 3",
          "addressMatch": true,
          "streetAddress1": "sample string 5",
          "streetAddress2": "sample string 6",
          "city": "sample string 7",
          "zipCode": "sample string 8",
          "county": "sample string 9",
          "state": "sample string 10",
          "country": "sample string 11",
          "latitude": "sample string 12",
          "longitude": "sample string 13"
        }
      ],
      "messages": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "success": true
    },
    {
      "locId": "sample string 1",
      "originalAddress": "sample string 2",
      "locations": [
        {
          "formattedAddress": "sample string 1",
          "locationMatchType": "sample string 2",
          "matchLevel": "sample string 3",
          "addressMatch": true,
          "streetAddress1": "sample string 5",
          "streetAddress2": "sample string 6",
          "city": "sample string 7",
          "zipCode": "sample string 8",
          "county": "sample string 9",
          "state": "sample string 10",
          "country": "sample string 11",
          "latitude": "sample string 12",
          "longitude": "sample string 13"
        },
        {
          "formattedAddress": "sample string 1",
          "locationMatchType": "sample string 2",
          "matchLevel": "sample string 3",
          "addressMatch": true,
          "streetAddress1": "sample string 5",
          "streetAddress2": "sample string 6",
          "city": "sample string 7",
          "zipCode": "sample string 8",
          "county": "sample string 9",
          "state": "sample string 10",
          "country": "sample string 11",
          "latitude": "sample string 12",
          "longitude": "sample string 13"
        },
        {
          "formattedAddress": "sample string 1",
          "locationMatchType": "sample string 2",
          "matchLevel": "sample string 3",
          "addressMatch": true,
          "streetAddress1": "sample string 5",
          "streetAddress2": "sample string 6",
          "city": "sample string 7",
          "zipCode": "sample string 8",
          "county": "sample string 9",
          "state": "sample string 10",
          "country": "sample string 11",
          "latitude": "sample string 12",
          "longitude": "sample string 13"
        }
      ],
      "messages": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "success": true
    },
    {
      "locId": "sample string 1",
      "originalAddress": "sample string 2",
      "locations": [
        {
          "formattedAddress": "sample string 1",
          "locationMatchType": "sample string 2",
          "matchLevel": "sample string 3",
          "addressMatch": true,
          "streetAddress1": "sample string 5",
          "streetAddress2": "sample string 6",
          "city": "sample string 7",
          "zipCode": "sample string 8",
          "county": "sample string 9",
          "state": "sample string 10",
          "country": "sample string 11",
          "latitude": "sample string 12",
          "longitude": "sample string 13"
        },
        {
          "formattedAddress": "sample string 1",
          "locationMatchType": "sample string 2",
          "matchLevel": "sample string 3",
          "addressMatch": true,
          "streetAddress1": "sample string 5",
          "streetAddress2": "sample string 6",
          "city": "sample string 7",
          "zipCode": "sample string 8",
          "county": "sample string 9",
          "state": "sample string 10",
          "country": "sample string 11",
          "latitude": "sample string 12",
          "longitude": "sample string 13"
        },
        {
          "formattedAddress": "sample string 1",
          "locationMatchType": "sample string 2",
          "matchLevel": "sample string 3",
          "addressMatch": true,
          "streetAddress1": "sample string 5",
          "streetAddress2": "sample string 6",
          "city": "sample string 7",
          "zipCode": "sample string 8",
          "county": "sample string 9",
          "state": "sample string 10",
          "country": "sample string 11",
          "latitude": "sample string 12",
          "longitude": "sample string 13"
        }
      ],
      "messages": [
        "sample string 1",
        "sample string 2",
        "sample string 3"
      ],
      "success": true
    }
  ],
  "totalProcessed": 2,
  "successCount": 3,
  "errorCount": 4,
  "apiMessages": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ]
}

text/html

Sample:

{"requestId":"sample string 1","results":[{"locId":"sample string 1","originalAddress":"sample string 2","locations":[{"formattedAddress":"sample string 1","locationMatchType":"sample string 2","matchLevel":"sample string 3","addressMatch":true,"streetAddress1":"sample string 5","streetAddress2":"sample string 6","city":"sample string 7","zipCode":"sample string 8","county":"sample string 9","state":"sample string 10","country":"sample string 11","latitude":"sample string 12","longitude":"sample string 13"},{"formattedAddress":"sample string 1","locationMatchType":"sample string 2","matchLevel":"sample string 3","addressMatch":true,"streetAddress1":"sample string 5","streetAddress2":"sample string 6","city":"sample string 7","zipCode":"sample string 8","county":"sample string 9","state":"sample string 10","country":"sample string 11","latitude":"sample string 12","longitude":"sample string 13"},{"formattedAddress":"sample string 1","locationMatchType":"sample string 2","matchLevel":"sample string 3","addressMatch":true,"streetAddress1":"sample string 5","streetAddress2":"sample string 6","city":"sample string 7","zipCode":"sample string 8","county":"sample string 9","state":"sample string 10","country":"sample string 11","latitude":"sample string 12","longitude":"sample string 13"}],"messages":["sample string 1","sample string 2","sample string 3"],"success":true},{"locId":"sample string 1","originalAddress":"sample string 2","locations":[{"formattedAddress":"sample string 1","locationMatchType":"sample string 2","matchLevel":"sample string 3","addressMatch":true,"streetAddress1":"sample string 5","streetAddress2":"sample string 6","city":"sample string 7","zipCode":"sample string 8","county":"sample string 9","state":"sample string 10","country":"sample string 11","latitude":"sample string 12","longitude":"sample string 13"},{"formattedAddress":"sample string 1","locationMatchType":"sample string 2","matchLevel":"sample string 3","addressMatch":true,"streetAddress1":"sample string 5","streetAddress2":"sample string 6","city":"sample string 7","zipCode":"sample string 8","county":"sample string 9","state":"sample string 10","country":"sample string 11","latitude":"sample string 12","longitude":"sample string 13"},{"formattedAddress":"sample string 1","locationMatchType":"sample string 2","matchLevel":"sample string 3","addressMatch":true,"streetAddress1":"sample string 5","streetAddress2":"sample string 6","city":"sample string 7","zipCode":"sample string 8","county":"sample string 9","state":"sample string 10","country":"sample string 11","latitude":"sample string 12","longitude":"sample string 13"}],"messages":["sample string 1","sample string 2","sample string 3"],"success":true},{"locId":"sample string 1","originalAddress":"sample string 2","locations":[{"formattedAddress":"sample string 1","locationMatchType":"sample string 2","matchLevel":"sample string 3","addressMatch":true,"streetAddress1":"sample string 5","streetAddress2":"sample string 6","city":"sample string 7","zipCode":"sample string 8","county":"sample string 9","state":"sample string 10","country":"sample string 11","latitude":"sample string 12","longitude":"sample string 13"},{"formattedAddress":"sample string 1","locationMatchType":"sample string 2","matchLevel":"sample string 3","addressMatch":true,"streetAddress1":"sample string 5","streetAddress2":"sample string 6","city":"sample string 7","zipCode":"sample string 8","county":"sample string 9","state":"sample string 10","country":"sample string 11","latitude":"sample string 12","longitude":"sample string 13"},{"formattedAddress":"sample string 1","locationMatchType":"sample string 2","matchLevel":"sample string 3","addressMatch":true,"streetAddress1":"sample string 5","streetAddress2":"sample string 6","city":"sample string 7","zipCode":"sample string 8","county":"sample string 9","state":"sample string 10","country":"sample string 11","latitude":"sample string 12","longitude":"sample string 13"}],"messages":["sample string 1","sample string 2","sample string 3"],"success":true}],"totalProcessed":2,"successCount":3,"errorCount":4,"apiMessages":["sample string 1","sample string 2","sample string 3"]}

application/xml, text/xml

Sample:

<AddressLookupResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <APIMessages>
    <string>sample string 1</string>
    <string>sample string 2</string>
    <string>sample string 3</string>
  </APIMessages>
  <RequestId>sample string 1</RequestId>
  <Results>
    <AddressLookupResult>
      <LocId>sample string 1</LocId>
      <OriginalAddress>sample string 2</OriginalAddress>
      <Locations>
        <APILocation>
          <FormattedAddress>sample string 1</FormattedAddress>
          <LocationMatchType>sample string 2</LocationMatchType>
          <MatchLevel>sample string 3</MatchLevel>
          <AddressMatch>true</AddressMatch>
          <StreetAddress1>sample string 5</StreetAddress1>
          <StreetAddress2>sample string 6</StreetAddress2>
          <City>sample string 7</City>
          <ZipCode>sample string 8</ZipCode>
          <County>sample string 9</County>
          <State>sample string 10</State>
          <Country>sample string 11</Country>
          <Latitude>sample string 12</Latitude>
          <Longitude>sample string 13</Longitude>
        </APILocation>
        <APILocation>
          <FormattedAddress>sample string 1</FormattedAddress>
          <LocationMatchType>sample string 2</LocationMatchType>
          <MatchLevel>sample string 3</MatchLevel>
          <AddressMatch>true</AddressMatch>
          <StreetAddress1>sample string 5</StreetAddress1>
          <StreetAddress2>sample string 6</StreetAddress2>
          <City>sample string 7</City>
          <ZipCode>sample string 8</ZipCode>
          <County>sample string 9</County>
          <State>sample string 10</State>
          <Country>sample string 11</Country>
          <Latitude>sample string 12</Latitude>
          <Longitude>sample string 13</Longitude>
        </APILocation>
        <APILocation>
          <FormattedAddress>sample string 1</FormattedAddress>
          <LocationMatchType>sample string 2</LocationMatchType>
          <MatchLevel>sample string 3</MatchLevel>
          <AddressMatch>true</AddressMatch>
          <StreetAddress1>sample string 5</StreetAddress1>
          <StreetAddress2>sample string 6</StreetAddress2>
          <City>sample string 7</City>
          <ZipCode>sample string 8</ZipCode>
          <County>sample string 9</County>
          <State>sample string 10</State>
          <Country>sample string 11</Country>
          <Latitude>sample string 12</Latitude>
          <Longitude>sample string 13</Longitude>
        </APILocation>
      </Locations>
      <Messages>
        <string>sample string 1</string>
        <string>sample string 2</string>
        <string>sample string 3</string>
      </Messages>
      <Success>true</Success>
    </AddressLookupResult>
    <AddressLookupResult>
      <LocId>sample string 1</LocId>
      <OriginalAddress>sample string 2</OriginalAddress>
      <Locations>
        <APILocation>
          <FormattedAddress>sample string 1</FormattedAddress>
          <LocationMatchType>sample string 2</LocationMatchType>
          <MatchLevel>sample string 3</MatchLevel>
          <AddressMatch>true</AddressMatch>
          <StreetAddress1>sample string 5</StreetAddress1>
          <StreetAddress2>sample string 6</StreetAddress2>
          <City>sample string 7</City>
          <ZipCode>sample string 8</ZipCode>
          <County>sample string 9</County>
          <State>sample string 10</State>
          <Country>sample string 11</Country>
          <Latitude>sample string 12</Latitude>
          <Longitude>sample string 13</Longitude>
        </APILocation>
        <APILocation>
          <FormattedAddress>sample string 1</FormattedAddress>
          <LocationMatchType>sample string 2</LocationMatchType>
          <MatchLevel>sample string 3</MatchLevel>
          <AddressMatch>true</AddressMatch>
          <StreetAddress1>sample string 5</StreetAddress1>
          <StreetAddress2>sample string 6</StreetAddress2>
          <City>sample string 7</City>
          <ZipCode>sample string 8</ZipCode>
          <County>sample string 9</County>
          <State>sample string 10</State>
          <Country>sample string 11</Country>
          <Latitude>sample string 12</Latitude>
          <Longitude>sample string 13</Longitude>
        </APILocation>
        <APILocation>
          <FormattedAddress>sample string 1</FormattedAddress>
          <LocationMatchType>sample string 2</LocationMatchType>
          <MatchLevel>sample string 3</MatchLevel>
          <AddressMatch>true</AddressMatch>
          <StreetAddress1>sample string 5</StreetAddress1>
          <StreetAddress2>sample string 6</StreetAddress2>
          <City>sample string 7</City>
          <ZipCode>sample string 8</ZipCode>
          <County>sample string 9</County>
          <State>sample string 10</State>
          <Country>sample string 11</Country>
          <Latitude>sample string 12</Latitude>
          <Longitude>sample string 13</Longitude>
        </APILocation>
      </Locations>
      <Messages>
        <string>sample string 1</string>
        <string>sample string 2</string>
        <string>sample string 3</string>
      </Messages>
      <Success>true</Success>
    </AddressLookupResult>
    <AddressLookupResult>
      <LocId>sample string 1</LocId>
      <OriginalAddress>sample string 2</OriginalAddress>
      <Locations>
        <APILocation>
          <FormattedAddress>sample string 1</FormattedAddress>
          <LocationMatchType>sample string 2</LocationMatchType>
          <MatchLevel>sample string 3</MatchLevel>
          <AddressMatch>true</AddressMatch>
          <StreetAddress1>sample string 5</StreetAddress1>
          <StreetAddress2>sample string 6</StreetAddress2>
          <City>sample string 7</City>
          <ZipCode>sample string 8</ZipCode>
          <County>sample string 9</County>
          <State>sample string 10</State>
          <Country>sample string 11</Country>
          <Latitude>sample string 12</Latitude>
          <Longitude>sample string 13</Longitude>
        </APILocation>
        <APILocation>
          <FormattedAddress>sample string 1</FormattedAddress>
          <LocationMatchType>sample string 2</LocationMatchType>
          <MatchLevel>sample string 3</MatchLevel>
          <AddressMatch>true</AddressMatch>
          <StreetAddress1>sample string 5</StreetAddress1>
          <StreetAddress2>sample string 6</StreetAddress2>
          <City>sample string 7</City>
          <ZipCode>sample string 8</ZipCode>
          <County>sample string 9</County>
          <State>sample string 10</State>
          <Country>sample string 11</Country>
          <Latitude>sample string 12</Latitude>
          <Longitude>sample string 13</Longitude>
        </APILocation>
        <APILocation>
          <FormattedAddress>sample string 1</FormattedAddress>
          <LocationMatchType>sample string 2</LocationMatchType>
          <MatchLevel>sample string 3</MatchLevel>
          <AddressMatch>true</AddressMatch>
          <StreetAddress1>sample string 5</StreetAddress1>
          <StreetAddress2>sample string 6</StreetAddress2>
          <City>sample string 7</City>
          <ZipCode>sample string 8</ZipCode>
          <County>sample string 9</County>
          <State>sample string 10</State>
          <Country>sample string 11</Country>
          <Latitude>sample string 12</Latitude>
          <Longitude>sample string 13</Longitude>
        </APILocation>
      </Locations>
      <Messages>
        <string>sample string 1</string>
        <string>sample string 2</string>
        <string>sample string 3</string>
      </Messages>
      <Success>true</Success>
    </AddressLookupResult>
  </Results>
  <TotalProcessed>2</TotalProcessed>
  <SuccessCount>3</SuccessCount>
  <ErrorCount>4</ErrorCount>
</AddressLookupResponse>

text/javascript, application/javascript, application/json-p

Sample:

({"requestId":"sample string 1","results":[{"locId":"sample string 1","originalAddress":"sample string 2","locations":[{"formattedAddress":"sample string 1","locationMatchType":"sample string 2","matchLevel":"sample string 3","addressMatch":true,"streetAddress1":"sample string 5","streetAddress2":"sample string 6","city":"sample string 7","zipCode":"sample string 8","county":"sample string 9","state":"sample string 10","country":"sample string 11","latitude":"sample string 12","longitude":"sample string 13"},{"formattedAddress":"sample string 1","locationMatchType":"sample string 2","matchLevel":"sample string 3","addressMatch":true,"streetAddress1":"sample string 5","streetAddress2":"sample string 6","city":"sample string 7","zipCode":"sample string 8","county":"sample string 9","state":"sample string 10","country":"sample string 11","latitude":"sample string 12","longitude":"sample string 13"},{"formattedAddress":"sample string 1","locationMatchType":"sample string 2","matchLevel":"sample string 3","addressMatch":true,"streetAddress1":"sample string 5","streetAddress2":"sample string 6","city":"sample string 7","zipCode":"sample string 8","county":"sample string 9","state":"sample string 10","country":"sample string 11","latitude":"sample string 12","longitude":"sample string 13"}],"messages":["sample string 1","sample string 2","sample string 3"],"success":true},{"locId":"sample string 1","originalAddress":"sample string 2","locations":[{"formattedAddress":"sample string 1","locationMatchType":"sample string 2","matchLevel":"sample string 3","addressMatch":true,"streetAddress1":"sample string 5","streetAddress2":"sample string 6","city":"sample string 7","zipCode":"sample string 8","county":"sample string 9","state":"sample string 10","country":"sample string 11","latitude":"sample string 12","longitude":"sample string 13"},{"formattedAddress":"sample string 1","locationMatchType":"sample string 2","matchLevel":"sample string 3","addressMatch":true,"streetAddress1":"sample string 5","streetAddress2":"sample string 6","city":"sample string 7","zipCode":"sample string 8","county":"sample string 9","state":"sample string 10","country":"sample string 11","latitude":"sample string 12","longitude":"sample string 13"},{"formattedAddress":"sample string 1","locationMatchType":"sample string 2","matchLevel":"sample string 3","addressMatch":true,"streetAddress1":"sample string 5","streetAddress2":"sample string 6","city":"sample string 7","zipCode":"sample string 8","county":"sample string 9","state":"sample string 10","country":"sample string 11","latitude":"sample string 12","longitude":"sample string 13"}],"messages":["sample string 1","sample string 2","sample string 3"],"success":true},{"locId":"sample string 1","originalAddress":"sample string 2","locations":[{"formattedAddress":"sample string 1","locationMatchType":"sample string 2","matchLevel":"sample string 3","addressMatch":true,"streetAddress1":"sample string 5","streetAddress2":"sample string 6","city":"sample string 7","zipCode":"sample string 8","county":"sample string 9","state":"sample string 10","country":"sample string 11","latitude":"sample string 12","longitude":"sample string 13"},{"formattedAddress":"sample string 1","locationMatchType":"sample string 2","matchLevel":"sample string 3","addressMatch":true,"streetAddress1":"sample string 5","streetAddress2":"sample string 6","city":"sample string 7","zipCode":"sample string 8","county":"sample string 9","state":"sample string 10","country":"sample string 11","latitude":"sample string 12","longitude":"sample string 13"},{"formattedAddress":"sample string 1","locationMatchType":"sample string 2","matchLevel":"sample string 3","addressMatch":true,"streetAddress1":"sample string 5","streetAddress2":"sample string 6","city":"sample string 7","zipCode":"sample string 8","county":"sample string 9","state":"sample string 10","country":"sample string 11","latitude":"sample string 12","longitude":"sample string 13"}],"messages":["sample string 1","sample string 2","sample string 3"],"success":true}],"totalProcessed":2,"successCount":3,"errorCount":4,"apiMessages":["sample string 1","sample string 2","sample string 3"]});