GET Location?RawAddress={RawAddress}&AllMatchLevels={AllMatchLevels}&ResetCache={ResetCache}&APIIdentifier={APIIdentifier}&User={User}
The Location service returns a valid complete location, based on a partial unparsed address
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| RawAddress | Address to search on. Example: 945 east paces ferry 30326 (Required) |
Define this parameter in the request URI. |
| AllMatchLevels | All matches will be returned regardless of match level. Example: true (Optional) |
Define this parameter in the request URI. |
| ResetCache | Reset cache with new lookup. Example: true (Optional) |
Define this parameter in the request URI. |
| APIIdentifier | An identifier assigned to MGAs by RSUI. Example: 5a6c7790-83bf-4b4c-88e1-7067413d3390 (Required) |
Define this parameter in the request URI. |
| User | User Name that matches with the APIIdentifier. Example: John Smith (Required) |
Define this parameter in the request URI. |
Response Information
The service may return more than one Location if multiple locations are found. (Error messages will be in the ApiMessages field)
Response body formats
application/json, text/json
Sample:
{
"locations": [
{
"formattedAddress": "945 East Paces Ferry Road Northeast, Atlanta, GA 30326, USA",
"matchLevel": "Street Address",
"addressMatch": false,
"streetAddress1": "945 East Paces Ferry Road Northeast",
"city": "Atlanta",
"zipCode": "30326",
"county": "Fulton",
"state": "GA",
"country": "US",
"latitude": "33.8465732",
"longitude": "-84.3562778"
}
],
"apiMessages": [
"Number of locations returned: 1"
]
}
text/html
Sample:
{"locations":[{"formattedAddress":"945 East Paces Ferry Road Northeast, Atlanta, GA 30326, USA","matchLevel":"Street Address","addressMatch":false,"streetAddress1":"945 East Paces Ferry Road Northeast","city":"Atlanta","zipCode":"30326","county":"Fulton","state":"GA","country":"US","latitude":"33.8465732","longitude":"-84.3562778"}],"apiMessages":["Number of locations returned: 1"]}
application/xml, text/xml
Sample:
<LocationResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<APIMessages>
<string>Number of locations returned: 1</string>
</APIMessages>
<Locations>
<APILocation>
<FormattedAddress>945 East Paces Ferry Road Northeast, Atlanta, GA 30326, USA</FormattedAddress>
<MatchLevel>Street Address</MatchLevel>
<AddressMatch>false</AddressMatch>
<StreetAddress1>945 East Paces Ferry Road Northeast</StreetAddress1>
<City>Atlanta</City>
<ZipCode>30326</ZipCode>
<County>Fulton</County>
<State>GA</State>
<Country>US</Country>
<Latitude>33.8465732</Latitude>
<Longitude>-84.3562778</Longitude>
</APILocation>
</Locations>
</LocationResponse>
text/javascript, application/javascript, application/json-p
Sample:
({"locations":[{"formattedAddress":"945 East Paces Ferry Road Northeast, Atlanta, GA 30326, USA","matchLevel":"Street Address","addressMatch":false,"streetAddress1":"945 East Paces Ferry Road Northeast","city":"Atlanta","zipCode":"30326","county":"Fulton","state":"GA","country":"US","latitude":"33.8465732","longitude":"-84.3562778"}],"apiMessages":["Number of locations returned: 1"]});