Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This method is available to developers from the Locate.asmx Web Service and generates a list of results matching your supplied parameters.

Code Block
titleSyntax
http://localhost/isharemaps_internal/locate.asmx?op=LocationSearch&searchString=High+StreetHigh%20Street&DataType=Property&searchType=Location&offset=0&pageSise=10

Parameters


 

Name

Requirement

Description

searchString

mandatory

The search string

A free form text string to search for.

dataType

mandatory

This will normally be "Property" unless you have more than one gazetteer e.g. if a dual language gazetteer is being used where this could be set to 'ENG' for English addresses and 'CYM' for Welsh.

searchType

mandatory

The type of search that you wish to perform e.g. for Address Searching use "Location". For a UPRN search use "Uniqueid"

offset

mandatory

This is the offset to the first result returned.

A page offset which corresponds with the pageSize parameter

pageSize

mandatory

The number of results to return.

 


Returns

A list of matching addresses.