Accessing the Local Knowledge Web Service
Cadcorp SIS Notice Board 9 includes the Local Knowledge Web Service for displaying information about a location.
The results are incorporated into a user interface to show the found features on a Notice Board.
A number of different queries can be defined on data layers including:
- Area – which area feature covers the location?
- Statistic – give me statistics about the location, using a defined buffer size
- NearestN – what are the nearest 5 (user defined) features?
- Distance – which features are within a defined distance of the location?
A number of Local Knowledge services can be set up using:
- A SWD of data layers with the query type defined
- A set of templates which define how the data will be displayed
Local Knowledge queries are normally run within Notice Board itself using the results of Quick Search queries or the centre of the map.
But it is possible to get Local Knowledge results without viewing a map; to do this use the HTTP POST requests directly against the Local Knowledge web service.
This is installed with Notice Board in the root folder, usually C:\inetpub\wwwroot\NoticeBoard9\LocalKnowledge.asmx
Making Requests to LocalKnowledge.asmx
This section explains the process for doing this in Postman.
For sample Postman requests, see here > (LocalKnowledge.postman.json)
There are two requests available:
1. GetLocalKnowledgeOverlays
Returns the available layers and their queries. There are potentially a number of Local Knowledge services available to run different queries.
Request
|
Path |
http://localhost/NoticeBoard9/localknowledge.asmx/ |
|
Request Type |
POST |
|
Header KEY |
content-type |
|
Header VALUE |
application/json |
|
Body |
{localKnowledgeID:1} localKnowledgeID:1 – number which identifies the Local Knowledge definition. To get this number you may need to look in the LocalKnowledge table in the webMapLayersConfig database, usually found in C:\inetpub\wwwroot\NoticeBoard9\App_Data\webMapLayersConfig.db. Each row in the table holds a separate Local Knowledge definition, based on an SWD. |
Response
Running the POST request will return an array of objects that represent the searchable overlays.
In this example, the overlay in the SWD is “Your nearest 5 supermarkets are“ and, importantly the “Number” for the query (and overlay) is 3.
TIP: It is good practice when creating SWDs for Local Knowledge to name the overlays with the text which describes the query
This is reflected in the SWD used for the Local Knowledge – overlays are numbered from the top down starting at zero:
2. LocalKnowledge
Returns individual queries from Local Knowledge for the defined location.
Request
|
Path |
http://localhost/NoticeBoard9/localknowledge.asmx/ |
|
Request Type |
POST |
|
Header KEY |
content-type |
|
Header VALUE |
application/json |
|
Body |
{localKnowledgeID:1,overlayNo:3,x:523538,y:223610} The body must be JSON localKnowledgeID:1 – number which identifies the Local Knowledge definition overlayNo:3 – number which identifies the overlay and query in the Local Knowledge SWD which you want to run x:523538 – x coordinate for the location y:223610 – y coordinate for the location |
Response
Running the LocalKnowledge request will return an array of information including a summary of the query and fully attributed results. The response structure will change dependent on the type of query.
Local Knowledge type response – area
Local Knowledge type - statistic
Local Knowledge type – nearestN (showing the first of 5 items returned)
Local Knowledge type – distance (showing the first of n items found in a 20000m radius)
