If you want to specify a radius for the search, use the SearchRadius parameter. If you leave it blank, the radius considered is 10 Miles. However, the maximum radius that you can specify is 100 Miles.
- AddressLine1
- Latitude/Longitude or IPAddress or Country
- AddressLine1
- Country
- Latitude/Longitude or IPAddress
For the search results beyond 100 Miles, you will get the results in sequence. SearchRadius results will come first, followed by wide search results.
|
Parameter |
Format |
Description |
|---|---|---|
|
AddressLine1 |
String |
The first address line. It may contain City, StateProvince or PostalCode information. It is a mandatory field. Note: The
guidelines given below do not apply if you provide City, StateProvince, or
PostalCode along with AddressLine1.
|
|
City |
String |
The city name. It is only specified when results need to be restricted to a city. |
|
StateProvince |
String |
The state or province. It is only specified when results need to be restricted to a state or province. |
|
InstanceKey |
String |
The InstanceKey is used for usage tracking purposes so that you are only charged each time a user looks up an address and not each time the service is called. An instance key can be created by calling the CreateAddressingInstanceKey service before the first time you call a Global Type Ahead service. The service will then return an InstanceKey value that is the same. If it is different, that means the same InstanceKey has been used too long. You should pass this new InstanceKey to subsequent calls until the user has selected an address or abandoned an address. Refer to GlobalTypeAhead example that explains the usage of InstanceKey.
Note: If you are entering multiple addresses, such as a separate Ship To and Ship From addresses, these are considered separate address lookups and do not share the same InstanceKey.
|
|
IpAddress |
Optional |
Specifies the ip address to be used to detect the location to perform the address search around that location. The parameter is used only when explicit location (latitude and longitude) is not provided in the request. If the ip address is provided in input request, it will be used for detecting location. |
|
Longitude |
Optional | The longitude of the location. (WGS 84 datum/EPSG:4326 coordinate system) |
|
Latitude |
Optional | The latitude of the location. (WGS 84 datum/EPSG:4326 coordinate system) |
|
SearchRadius |
Optional | Specifies the radius within which this service searches for results. If not provided, the default value is 10 Miles. The allowed minimum value is greater than 0 and maximum range in all allowed units is mentioned below: In Miles: upto 100 Miles In Feet: upto 528000 Feet In Kilometers: 160.934 Kilometers In Meters: 160934 Meters Default Radius: 10 |
|
SearchRadiusUnit |
Optional | The acceptable unit values are: Feet, Kilometers, Miles and Meters. The searchRadiusUnit is optional, if not provided, the unit ‘Miles’ is taken by default, otherwise the search is performed based upon the searchRadius calculated in the specified unit. The search results are returned accordingly in the specified unit. For example, 'Kilometers' searchRadiusUnit returns results in 'Kilometers'. The input values are case-insensitive. Default unit: Miles |
|
PostalCode |
String |
The postal code. It is only specified when results need to be restricted to a postal code. |
|
PostCode |
String |
The post code. |
|
Country |
String |
The country code or name, in any of the formats below:
For a list of ISO codes, see ISO Country Codes and Module Support. The ISO codes are as follows:
|