OS Names API - Quick Search Configuration

WebMap supports the OS Names API which can be added to Quick Search. This provides an easy and current dataset for searching on postcodes, roads and place names for Great Britain.

  1. Sign up for a free OS Names API key - https://osdatahub.os.uk/
  2. Open the webMapLayersConfig.db in a SQLite database browser (usually located C:\inetpub\wwwroot\SISWebMap9.0\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

Pick a ResolutionID from the Resolutions Table (ensure it corresponds with the correct MapID).

ZoomScaleID

ZoomScaleID

NorthingProperty

is the Northing property specified by the Ordnance Survey, set to Geometry_Y

EastingProperty

is the Easting property specified by the Ordnance Survey, set to Geometry_X

ResultProperty

is the Result value from the Ordnance Survey, 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

Values from the OS Names API must be upper case.