|
Search Thoroughfare
The Search Thoroughfare functions allow you to search for Address Thoroughfares. An Address Thoroughfare is a Unique Street and Locality Location and a search will return a collection of 'List Address' and Unique_Identifiers for all the thoroughfares for the criteria in the search. These functions are used in conjunction with the 'Search Premise' and 'Get Address' functions. Example: Use the SearchThoroughfare_ByStreet function to return a list of Thoroughfares for a known street name (zero credits). Use the SearchPremise_ByThoroughfareID function to return a list of Premise Addresses for the selected thoroughfare(zero credits). Select the Address from the list and return the Full Premise Address using the GetPremiseAddress function (1 credit). This search is useful when a search criteria is vague and a Search on Premise would return too many Premises. e.g. You want all streets in the postcode district 'G52' or you know the name part of the street name. This search can be used in conjunction with the SearchPremise_ByThoroughfareID and SearchPremise_ByThoroughfareID_Dataset functions. The List below describes the functions available: *Try not to search on 'Noise' words ONLY. e.g. 'street', 'bank', 'house', etc as this will result in a 302 error being returned. Always be as specific as possible e.g. street='high st', town='glasgow'.
| Function Name |
Function Description |
| SearchThoroughfare_ByPostcodeDistrict |
This search takes 1 parameter and returns a collection of ListAddressThoroughfare objects.
The 'Postcode District' parameter must be entered.
The Postcode District is the part of a Postcode before the space.
e.g. G52 4NQ - Postcode District is G52 |
| SearchThoroughfare_ByPostcodeDistrict_Dataset |
This search is the same as SearchThoroughfare_ByPostcodeDistrict but returns the data as a PostcodeUtilities dataset with a populated ListAddressThoroughfare table. |
| SearchThoroughfare_ByStreet |
This search takes 3 parameters and returns a collection of ListAddressThoroughfare objects. The 'Street' parameter must be entered. The 'Number' parameter is optional.
The 'Town' parameter is optional. * |
| SearchPremise_ByStreet_Dataset |
This search is the same as SearchThoroughfare_ByStreet but returns the data as a PostcodeUtilities dataset with a populated ListAddressPremise table. * | A formal description of the services can be found in the 'Service Description' section of
The response to a call of the above functions returns a collection of List Address Thoroughfares either as a dataset or List depending on the method invoked. |