Partner Sourced datasets
The Typedown search type is optimized for users to start searching with the most general address element and, once that has been found, move on to more specific parts of the address. Typedown is a useful search option when a user is certain of the address information.
With Typedown searching, Pro Web will always look for an exact match first, but generally involves two, three or four stages. Prompt sets are used to guide the user as to what information should be entered at each stage. The Typedown search type usually returns a list of suggestions after three or four characters, from which the user can select a place name from the first stage. Ideally, the user will always enter information that generates the smallest number of matches. This makes the search more efficient, and makes it easier for the user to select the final address.
The returned suggestions may have one or more of the following properties:
Users can use any mixture of upper and lower case characters, as the Typedown engine does not differentiate between upper and lower case text. Also, users do not need to include spaces, as Typedown searching ignores them.
Pro Web SOAP enables an untrained user to capture their own address with minimal interaction by entering information into a wizard.
This is a multi-step process involving the following operations:
Operation | SOAP Action | Description |
---|---|---|
1. Can Search | DoCanSearch |
Checks whether the combination of data mapping, engine and layout are valid for search. |
2. Initial Search | DoSearch |
Performs the initial search. |
3. 'Step In' | DoRefine |
'Steps into' a picklist that was created during the previous search. |
4. Refine | DoRefine |
Refines the picklist that was created during the previous search. |
5. Get Final Address | DoGetAddress |
Creates a final formatted address from a previously created picklist item. |
Typically, the process of searching with the Singleline engine follows this format:
DoCanSearch
action.DoSearch
action can be used for the initial search. It returns a Picklist
object which contains PicklistItems
that can be displayed. Each item can remain merely informational, be expanded or formatted into a final address.DoRefine
action can be used to 'step into' a picklist result (for example, a street name will show a picklist of premises). This hierarchical picklist behavior is the default. If a single flattened picklist is required, the flatten flag has to be set before the initial search is performed.DoRefine
action can be used to narrow down the current picklist to one with a subset of items (for example, using "high" on street names will return another picklist containing only streets starting with "high").DoRefine
action is also called in certain special cases. For example, when an item is an unresolvable range (certain countries) or a Phantom Primary Point (AUS only).DoGetAddress
action can be used to format a final address. A call to stepIn
, refine
or DoGetAddress
requires a moniker from either the Picklist
or a PicklistItems
returned by a previous call. These monikers encode the information required to recreate a particular picklist/picklist item, and are the means by which any integration navigates the search process.DoGetAddress
action will apply a layout to this item, returning a FormattedAddress
object that contains the final formatted address.This type of search usually involves three stages.
Typically, after an initial search on a place or postal/ZIP code, Pro Web will look for street names. Once you have selected the street name that you want, you can enter a property number to return the full address.
You cannot type in the property number followed by the street name, as you can with Singleline searching, because Typedown searches cannot match on numbers until you have selected a street name.
This type of search enables users to capture address information for United Kingdom businesses and usually involves two stages: