OS Open Names - Quick Search Configuration

Web Map Layers 8.0 supports the OS Open Names API, which can be added and used for the Quick Search to provide an easy, fast and current dataset for searching on postcodes, roads and place names for Great Britain.

Steps to follow to add the OS Open Names to Quick Search for searching:

  1. Sign up for a free OS Names API key - https://developer.ordnancesurvey.co.uk/home
  2. Open the webMapLayersConfig.db in a SQLite database browser, usually located C:\inetpub\wwwroot\WebMapLayers8\App_Data
  3. Open the Search_OS_Open_Name Table and populate the record:
SearchID auto generated number
Name The name of the search, e.g. Postcode Search (OS Names)
MapID MapID value from the Map Table
IconID IconID value from the Icons Table
ZoomResolutionID The zoom to Resolution, pick a ResolutionID from the Resolutions Table, making sure it corresponds with the correct MapID
ZoomScaleID ZoomScaleID
NorthingProperty is the Northing property set by the Ordnance Survey, which should be set to Geometry_Y
EastingProperty is the Easting property set by the Ordnance Survey, which should be set to Geometry_X
ResultProperty is the Result value from the Ordnance Survey, which should be set to Name1
Key is the Ordnance Survey API key value
LocalTypeFilterID value from the FilterTypeID column in the Search_OS_Open_Name_Filter_Type Table e.g. 10 for Postcode
SecondaryResultProperty An example value is POPULATED_PLACE, which is likely to be the town or city name e.g. Cambridge
ResultsDelimiter used to space results when a SecondaryResultProperty is used

The example below shows a configuration for searching on Street and Postcodes

* The values entered into the Table are case sensitive. Values from the OS Open Names API must be upper case.

An example OS Open Names request:


Send comments on this topic.