Parameters for Input Data
GlobalTypeAhead USCAN takes an address fragment as input, for example, '123 Mai', '123 Main St, Apple', and returns candidate addresses that match the input.
Parameter | Format | Description |
---|---|---|
Data.AddressLine1 | String |
The firstaddress line. It may contain City, StateProvince or PostalCodeinformation. It is a mandatory field. Note: The
guidelines given below do not apply if you provide City, StateProvince, or
PostalCode along with AddressLine1.
|
Data.City | String | The city name. It is only specified when results need to be restricted to acity. |
Data.StateProvince | String | The state or province. It is only specified when results need to be restricted to astate or province. |
Data.InstanceKey | String | The InstanceKey is used for usage tracking purposes so that youare only charged each time a user looks up an address and noteach time the service is called. An instance key can be created by calling theCreateAddressingInstanceKey service before the first time youcall a Global Type Ahead service. The service will then return an InstanceKey value that is thesame. If it is different, that means the same InstanceKey hasbeen used too long. You should pass this new InstanceKey tosubsequent calls until the user has selected an address orabandoned 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. |
Data.PostCode | String | The post code. |
Data.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:
Note: This field is mandatory. |