- Support for rural route (RR), highway contract (HC), or P.O. boxaddress.
An address can be a street address, a rural route address, a highway contract address, a P.O. box address, a private mailbox address or a Military Post Boxes.
|
Parameter |
Format |
Description |
|---|---|---|
|
Data.AddressLine1 |
String |
The first addressline. It may contain City, StateProvince, PostalCode, or P.O.box number. 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.PostalCode |
String |
The postal code. It is only specified whenresults need to be restricted to a postal code. |
|
Data.PostCode |
String |
The post code. |