POST ConsolidatedLocation

The Consolidated Location service returns multiple valid complete locations in one call (including Territory, Distance to Coast and Classification information), based on a list of addresses

Request Information

Parameters

NameDescriptionAdditional information
multipleLocationRequest 
Parsed addresses with unique Premises Ids (allMatchLevels and omitAddressVerification are Optional)

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample: 
{
  "requestLocations": [
    {
      "premisesId": "1",
      "streetAddress1": "945 east paces ferry",
      "streetAddress2": "suite 1800",
      "city": "Atlanta",
      "zipCode": "30326",
      "county": "fulton",
      "state": "GA",
      "allMatchLevels": false,
      "omitAddressVerification": false,
      "buildingCharacteristics": false,
      "resetCache": false
    },
    {
      "premisesId": "2",
      "streetAddress1": "2551 East Hallandale Beach Boulevard",
      "city": "hallandale bEeach",
      "zipCode": "33009",
      "county": "cley",
      "state": "fl",
      "allMatchLevels": false,
      "omitAddressVerification": false,
      "buildingCharacteristics": false,
      "resetCache": false
    },
    {
      "premisesId": "4",
      "streetAddress1": "100 west thiRD st",
      "city": "sheridan",
      "zipCode": "78629",
      "county": "Brooks",
      "state": "tx",
      "allMatchLevels": false,
      "omitAddressVerification": false,
      "buildingCharacteristics": false,
      "resetCache": false
    }
  ],
  "apiIdentifier": "5a6c7790-83bf-4b4c-88e1-7067413d3390",
  "user": "John Smith"
}

text/html

Sample: 
{"requestLocations":[{"premisesId":"1","streetAddress1":"945 east paces ferry","streetAddress2":"suite 1800","city":"Atlanta","zipCode":"30326","county":"fulton","state":"GA","allMatchLevels":false,"omitAddressVerification":false,"buildingCharacteristics":false,"resetCache":false},{"premisesId":"2","streetAddress1":"2551 East Hallandale Beach Boulevard","city":"hallandale bEeach","zipCode":"33009","county":"cley","state":"fl","allMatchLevels":false,"omitAddressVerification":false,"buildingCharacteristics":false,"resetCache":false},{"premisesId":"4","streetAddress1":"100 west thiRD st","city":"sheridan","zipCode":"78629","county":"Brooks","state":"tx","allMatchLevels":false,"omitAddressVerification":false,"buildingCharacteristics":false,"resetCache":false}],"apiIdentifier":"5a6c7790-83bf-4b4c-88e1-7067413d3390","user":"John Smith"}

application/xml, text/xml

Sample: 
<ConsolidatedMultipleLocationRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <APIIdentifier>5a6c7790-83bf-4b4c-88e1-7067413d3390</APIIdentifier>
  <User>John Smith</User>
  <RateDate xsi:nil="true" />
  <RequestLocations>
    <ConsolidatedLocationRequest>
      <PremisesId>1</PremisesId>
      <StreetAddress1>945 east paces ferry</StreetAddress1>
      <StreetAddress2>suite 1800</StreetAddress2>
      <City>Atlanta</City>
      <ZipCode>30326</ZipCode>
      <County>fulton</County>
      <State>GA</State>
      <AllMatchLevels>false</AllMatchLevels>
      <OmitAddressVerification>false</OmitAddressVerification>
      <BuildingCharacteristics>false</BuildingCharacteristics>
      <ResetCache>false</ResetCache>
    </ConsolidatedLocationRequest>
    <ConsolidatedLocationRequest>
      <PremisesId>2</PremisesId>
      <StreetAddress1>2551 East Hallandale Beach Boulevard</StreetAddress1>
      <City>hallandale bEeach</City>
      <ZipCode>33009</ZipCode>
      <County>cley</County>
      <State>fl</State>
      <AllMatchLevels>false</AllMatchLevels>
      <OmitAddressVerification>false</OmitAddressVerification>
      <BuildingCharacteristics>false</BuildingCharacteristics>
      <ResetCache>false</ResetCache>
    </ConsolidatedLocationRequest>
    <ConsolidatedLocationRequest>
      <PremisesId>4</PremisesId>
      <StreetAddress1>100 west thiRD st</StreetAddress1>
      <City>sheridan</City>
      <ZipCode>78629</ZipCode>
      <County>Brooks</County>
      <State>tx</State>
      <AllMatchLevels>false</AllMatchLevels>
      <OmitAddressVerification>false</OmitAddressVerification>
      <BuildingCharacteristics>false</BuildingCharacteristics>
      <ResetCache>false</ResetCache>
    </ConsolidatedLocationRequest>
  </RequestLocations>
</ConsolidatedMultipleLocationRequest>

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 'ConsolidatedMultipleLocationRequest'.

Response Information

The service may return more than one Location, per submitted address, if multiple locations are found. (Error messages will be in the ApiMessages field)

Response body formats

application/json, text/json

Sample: 
{
  "responseLocations": [
    {
      "premisesId": "1",
      "locations": [
        {
          "warnings": [],
          "formattedAddress": "945 East Paces Ferry Road Northeast #1800, Atlanta, GA 30326, USA",
          "matchLevel": "Subpremise",
          "addressMatch": false,
          "streetAddress1": "945 East Paces Ferry Road Northeast",
          "streetAddress2": "Suite 1800",
          "city": "Atlanta",
          "zipCode": "30326",
          "county": "Fulton",
          "state": "GA",
          "country": "US",
          "latitude": "33.8464743",
          "longitude": "-84.35617889999999",
          "territories": [
            "502"
          ],
          "distanceToCoast": 233.34,
          "stateWindEligible": true,
          "locationWindEligible": true
        }
      ],
      "apiMessages": [
        "Number of locations returned: 1"
      ]
    },
    {
      "premisesId": "2",
      "locations": [
        {
          "warnings": [
            "City for this location 'Hallandale Beach' does not match the submitted City of 'Hallandale Beeach'",
            "County for this location 'Broward' does not match the submitted County of 'Cley'"
          ],
          "formattedAddress": "2551 East Hallandale Beach Boulevard, Seawalk Pointe Shopping Center, Hallandale Beach, FL 33009, USA",
          "matchLevel": "Street Address",
          "addressMatch": false,
          "streetAddress1": "2551 East Hallandale Beach Boulevard",
          "city": "Hallandale Beach",
          "zipCode": "33009",
          "county": "Broward",
          "state": "FL",
          "country": "US",
          "latitude": "25.987359",
          "longitude": "-80.12406799999999",
          "territories": [
            "001",
            "002"
          ],
          "distanceToCoast": 0.12,
          "stateWindEligible": true,
          "locationWindEligible": true,
          "tier": "1",
          "zone": "1"
        }
      ],
      "apiMessages": [
        "Number of locations returned: 1"
      ]
    },
    {
      "premisesId": "4",
      "locations": [
        {
          "warnings": [
            "Unable to find location"
          ],
          "formattedAddress": "100 West Third St, Sheridan, TX 78629",
          "matchLevel": "N/A",
          "addressMatch": false,
          "streetAddress1": "100 West Third St",
          "city": "Sheridan",
          "zipCode": "78629",
          "county": "Brooks",
          "state": "TX",
          "country": "US",
          "territories": [
            "006"
          ],
          "stateWindEligible": true,
          "locationWindEligible": false,
          "tier": "2",
          "region": "Coastal Texas"
        }
      ],
      "apiMessages": [
        "Number of locations returned: 1"
      ]
    }
  ],
  "apiMessages": []
}

text/html

Sample: 
{"responseLocations":[{"premisesId":"1","locations":[{"warnings":[],"formattedAddress":"945 East Paces Ferry Road Northeast #1800, Atlanta, GA 30326, USA","matchLevel":"Subpremise","addressMatch":false,"streetAddress1":"945 East Paces Ferry Road Northeast","streetAddress2":"Suite 1800","city":"Atlanta","zipCode":"30326","county":"Fulton","state":"GA","country":"US","latitude":"33.8464743","longitude":"-84.35617889999999","territories":["502"],"distanceToCoast":233.34,"stateWindEligible":true,"locationWindEligible":true}],"apiMessages":["Number of locations returned: 1"]},{"premisesId":"2","locations":[{"warnings":["City for this location 'Hallandale Beach' does not match the submitted City of 'Hallandale Beeach'","County for this location 'Broward' does not match the submitted County of 'Cley'"],"formattedAddress":"2551 East Hallandale Beach Boulevard, Seawalk Pointe Shopping Center, Hallandale Beach, FL 33009, USA","matchLevel":"Street Address","addressMatch":false,"streetAddress1":"2551 East Hallandale Beach Boulevard","city":"Hallandale Beach","zipCode":"33009","county":"Broward","state":"FL","country":"US","latitude":"25.987359","longitude":"-80.12406799999999","territories":["001","002"],"distanceToCoast":0.12,"stateWindEligible":true,"locationWindEligible":true,"tier":"1","zone":"1"}],"apiMessages":["Number of locations returned: 1"]},{"premisesId":"4","locations":[{"warnings":["Unable to find location"],"formattedAddress":"100 West Third St, Sheridan, TX 78629","matchLevel":"N/A","addressMatch":false,"streetAddress1":"100 West Third St","city":"Sheridan","zipCode":"78629","county":"Brooks","state":"TX","country":"US","territories":["006"],"stateWindEligible":true,"locationWindEligible":false,"tier":"2","region":"Coastal Texas"}],"apiMessages":["Number of locations returned: 1"]}],"apiMessages":[]}

application/xml, text/xml

Sample: 
<ConsolidatedMultipleLocationResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <APIMessages />
  <ResponseLocations>
    <ConsolidatedLocationResponse>
      <APIMessages>
        <string>Number of locations returned: 1</string>
      </APIMessages>
      <PremisesId>1</PremisesId>
      <Locations>
        <ConsolidatedLocation>
          <FormattedAddress>945 East Paces Ferry Road Northeast #1800, Atlanta, GA 30326, USA</FormattedAddress>
          <MatchLevel>Subpremise</MatchLevel>
          <AddressMatch>false</AddressMatch>
          <StreetAddress1>945 East Paces Ferry Road Northeast</StreetAddress1>
          <StreetAddress2>Suite 1800</StreetAddress2>
          <City>Atlanta</City>
          <ZipCode>30326</ZipCode>
          <County>Fulton</County>
          <State>GA</State>
          <Country>US</Country>
          <Latitude>33.8464743</Latitude>
          <Longitude>-84.35617889999999</Longitude>
          <Warnings />
          <Territories>
            <string>502</string>
          </Territories>
          <DistanceToCoast>233.34</DistanceToCoast>
          <MobileBayDTC xsi:nil="true" />
          <LakePontchartrainDTC xsi:nil="true" />
          <StateWindEligible>true</StateWindEligible>
          <LocationWindEligible>true</LocationWindEligible>
          <MobileBayRegion xsi:nil="true" />
          <DTCNotRequired xsi:nil="true" />
        </ConsolidatedLocation>
      </Locations>
    </ConsolidatedLocationResponse>
    <ConsolidatedLocationResponse>
      <APIMessages>
        <string>Number of locations returned: 1</string>
      </APIMessages>
      <PremisesId>2</PremisesId>
      <Locations>
        <ConsolidatedLocation>
          <FormattedAddress>2551 East Hallandale Beach Boulevard, Seawalk Pointe Shopping Center, Hallandale Beach, FL 33009, USA</FormattedAddress>
          <MatchLevel>Street Address</MatchLevel>
          <AddressMatch>false</AddressMatch>
          <StreetAddress1>2551 East Hallandale Beach Boulevard</StreetAddress1>
          <City>Hallandale Beach</City>
          <ZipCode>33009</ZipCode>
          <County>Broward</County>
          <State>FL</State>
          <Country>US</Country>
          <Latitude>25.987359</Latitude>
          <Longitude>-80.12406799999999</Longitude>
          <Warnings>
            <string>City for this location 'Hallandale Beach' does not match the submitted City of 'Hallandale Beeach'</string>
            <string>County for this location 'Broward' does not match the submitted County of 'Cley'</string>
          </Warnings>
          <Territories>
            <string>001</string>
            <string>002</string>
          </Territories>
          <DistanceToCoast>0.12</DistanceToCoast>
          <MobileBayDTC xsi:nil="true" />
          <LakePontchartrainDTC xsi:nil="true" />
          <StateWindEligible>true</StateWindEligible>
          <LocationWindEligible>true</LocationWindEligible>
          <MobileBayRegion xsi:nil="true" />
          <Tier>1</Tier>
          <Zone>1</Zone>
          <DTCNotRequired xsi:nil="true" />
        </ConsolidatedLocation>
      </Locations>
    </ConsolidatedLocationResponse>
    <ConsolidatedLocationResponse>
      <APIMessages>
        <string>Number of locations returned: 1</string>
      </APIMessages>
      <PremisesId>4</PremisesId>
      <Locations>
        <ConsolidatedLocation>
          <FormattedAddress>100 West Third St, Sheridan, TX 78629</FormattedAddress>
          <MatchLevel>N/A</MatchLevel>
          <AddressMatch>false</AddressMatch>
          <StreetAddress1>100 West Third St</StreetAddress1>
          <City>Sheridan</City>
          <ZipCode>78629</ZipCode>
          <County>Brooks</County>
          <State>TX</State>
          <Country>US</Country>
          <Warnings>
            <string>Unable to find location</string>
          </Warnings>
          <Territories>
            <string>006</string>
          </Territories>
          <DistanceToCoast xsi:nil="true" />
          <MobileBayDTC xsi:nil="true" />
          <LakePontchartrainDTC xsi:nil="true" />
          <StateWindEligible>true</StateWindEligible>
          <LocationWindEligible>false</LocationWindEligible>
          <MobileBayRegion xsi:nil="true" />
          <Tier>2</Tier>
          <Region>Coastal Texas</Region>
          <DTCNotRequired xsi:nil="true" />
        </ConsolidatedLocation>
      </Locations>
    </ConsolidatedLocationResponse>
  </ResponseLocations>
</ConsolidatedMultipleLocationResponse>

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

Sample: 
({"responseLocations":[{"premisesId":"1","locations":[{"warnings":[],"formattedAddress":"945 East Paces Ferry Road Northeast #1800, Atlanta, GA 30326, USA","matchLevel":"Subpremise","addressMatch":false,"streetAddress1":"945 East Paces Ferry Road Northeast","streetAddress2":"Suite 1800","city":"Atlanta","zipCode":"30326","county":"Fulton","state":"GA","country":"US","latitude":"33.8464743","longitude":"-84.35617889999999","territories":["502"],"distanceToCoast":233.34,"stateWindEligible":true,"locationWindEligible":true}],"apiMessages":["Number of locations returned: 1"]},{"premisesId":"2","locations":[{"warnings":["City for this location 'Hallandale Beach' does not match the submitted City of 'Hallandale Beeach'","County for this location 'Broward' does not match the submitted County of 'Cley'"],"formattedAddress":"2551 East Hallandale Beach Boulevard, Seawalk Pointe Shopping Center, Hallandale Beach, FL 33009, USA","matchLevel":"Street Address","addressMatch":false,"streetAddress1":"2551 East Hallandale Beach Boulevard","city":"Hallandale Beach","zipCode":"33009","county":"Broward","state":"FL","country":"US","latitude":"25.987359","longitude":"-80.12406799999999","territories":["001","002"],"distanceToCoast":0.12,"stateWindEligible":true,"locationWindEligible":true,"tier":"1","zone":"1"}],"apiMessages":["Number of locations returned: 1"]},{"premisesId":"4","locations":[{"warnings":["Unable to find location"],"formattedAddress":"100 West Third St, Sheridan, TX 78629","matchLevel":"N/A","addressMatch":false,"streetAddress1":"100 West Third St","city":"Sheridan","zipCode":"78629","county":"Brooks","state":"TX","country":"US","territories":["006"],"stateWindEligible":true,"locationWindEligible":false,"tier":"2","region":"Coastal Texas"}],"apiMessages":["Number of locations returned: 1"]}],"apiMessages":[]});