|
Search Premise
The Search Premise functions allow you to search for Address Premises. An Address Premise is a Unique Delivery Point and a search will return a collection of 'List Address' and Unique_Identifiers for all the delivery points for the criteria in the search. These functions are used in conjunction with the 'Get Address' functions. Example: Use the SearchPremise_ByPostcode function to return a list of Premise Addresses for a known postcode (zero credits). Select the Address from the list and return the Full Premise Address using the GetPremiseAddress function (1 credit). These searches are useful when you have specific search criteria like a full Postcode or Street Name, Number and Town. There are currently 28,000,000+ Unique Premise Delivery Points. The List below describes the functions available (zero credits used in search): *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' as this will speed up response times.
| Function Name |
Function Description |
| SearchPremise_ByPostcode |
This search takes 4 parameters and returns a collection of ListAddressPremise objects.
The 'Postcode' parameter must be entered.
The 'AccountName' parameter must be entered.
The 'LicenceID' parameter must be entered.
Leave 'MachineID' blank. |
| SearchPremise_ByPostcode_Dataset |
This search is the same as SearchPremise_ByPostcode but returns the data as a PostcodeUtilities dataset with a populated ListAddressPremise table. |
| SearchPremise_ByStreet |
This search takes 6 parameters and returns a collection of ListAddressPremise objects. The 'Street' parameter must be entered. The 'Number' parameter is optional.
The 'Town' parameter is optional.
The 'AccountName' parameter must be entered.
The 'LicenceID' parameter must be entered.
Leave 'MachineID' blank. * |
| SearchPremise_ByStreet_Dataset |
This search is the same as SearchPremise_ByStreet but returns the data as a PostcodeUtilities dataset with a populated ListAddressPremise table. * |
| SearchPremise_ByThoroughfareID |
This search takes 4 parameters and returns a collection of ListAddressPremise objects. The 'ThoroughfareID' parameter must be entered.
The 'AccountName' parameter must be entered.
The 'LicenceID' parameter must be entered.
Leave 'MachineID' blank.
This search is used in conjnction with the SearchThoroughfare_By... functions. |
| SearchPremise_ByThoroughfareID_Dataset |
This search is the same as SearchPremise_ByThoroughfareID but returns the data as a PostcodeUtilities dataset with a populated ListAddressPremise table. |
| SearchPremise_ByOrganisation |
This search takes 5 parameters and returns a collection of ListAddressPremise objects. The 'Organisation' parameter must be entered. The 'Town' parameter is optional.
The 'AccountName' parameter must be entered.
The 'LicenceID' parameter must be entered.
Leave 'MachineID' blank.* |
| SearchPremise_ByOrganisation_Dataset |
This search is the same as SearchPremise_ByOrganisation but returns the data as a PostcodeUtilities dataset with a populated ListAddressPremise table. * |
| SearchPremise_ByPOBox |
This search takes 5 parameter and returns a collection of ListAddressPremise objects. The 'POBox' parameter must be entered.
The 'Town' parameter is optional.
The 'AccountName' parameter must be entered.
The 'LicenceID' parameter must be entered.
Leave 'MachineID' blank. |
| SearchPremise_ByPOBox_Dataset |
This search is the same as SearchPremise_ByPOBox but returns the data as a PostcodeUtilities dataset with a populated ListAddressPremise table. |
| SearchPremise_ByWordMatchOnAll |
This search takes 4 parameters and returns a collection of ListAddressPremise objects.
The 'AccountName' parameter must be entered.
The 'LicenceID' parameter must be entered.
Leave 'MachineID' blank.
The word match is carried out on the POBox, Organisation_Department, Organisation, Sub_Building_Name, Building_Name, Dependent_Street, Street, Double_Dependent_Locality, Dependent_Locality, Posttown and Postcode fields.
You can enter multiple search criteria by separating them with commas.
e.g. Search on 'etellect ltd,etellect house' will search the above fields for the phrase 'etellect ltd' AND 'etellect house'.* |
| SearchPremise_ByWordMatchOnAll_Dataset |
This search is the same as SearchPremise_ByWordMatchOnAll 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 Premises either as a dataset or List depending on the method invoked. |