JSDoc: Global

Methods

allProxy(q) → {content}

Proxy cross domain requests Routes:

/proxy/

Parameters:

Name	Type	Description
`q`	string	encoded url with optional parameters

Returns:

Type: content

checkToken(token, res) → {undefined}

Parameters:

Name	Type	Description
`token`	type
`res`	type

To Do:

Describe function

Returns:

Type: undefined

eughs() → {text/html}

Render eughs symbol information page

Routes:

/eughs.html

Returns:

Type: text/html

geocode(req, res) → {undefined}

Geocode - Pass a query to nominatim and process the result see

Parameters:

Name	Type	Description
`req`	type
`res`	type

Returns:

Type: undefined

getAddress(id, sridopt, req, res) → {json}

Get an Address from the BAG by id

Routes:

/api/bag/adres/:id

Parameters:

Name	Type	Attributes	Default	Description
`id`	integer			id for address from the BAG
`srid`	integer	<optional>	4326	The EPSG projection for geometry
`req`	Request			Express request object
`res`	Response			Express response object

Returns:

Express res.json()

Type: json

getAutocomplete(searchphrase, req, res) → {json}

Autocomplete Search based upon a search phrase

Parameters:

Name	Type	Description
`searchphrase`	String	A (partial) phrase to look up an address
`req`	Request	Express request object
`res`	Response	Express response object

Returns:

Express res.json()

Type: json

getBagInfo(req, res) → {json}

Returns Information about the creation date for the BAG

Parameters:

Name	Type	Description
`req`	Request	Express request object
`res`	Response	Express response object

Returns:

Express res.json()

Type: json

getBuilding(sridopt, req, res) → {json}

Returns Buildings from the BAG

Routes:

Parameters:

Name	Type	Attributes	Default	Description
`srid`	integer	<optional>	4326	The EPSG projection for geometry
`req`	Request			Express request object
`res`	Response			Express response object

Returns:

Express res.json()

Type: json

getGroupByClass2(req, res) → {undefined}

Parameters:

Name	Type	Description
`req`	type
`res`	type

Returns:

Type: undefined

getGroupByClass3(req, res) → {undefined}

Parameters:

Name	Type	Description
`req`	type
`res`	type

Returns:

Type: undefined

getIndex(mobileopt, lopt) → {text/html}

Render the Application from jade templates based upon parameters and configuration

Routes:

Parameters:

Name	Type	Attributes	Description
`mobile`	string	<optional>	render as default or mobile enhanced
`l`	string	<optional>	language to render the application in. default can be configured in config.json

Returns:

Type: text/html

getJSON(req, res) → {undefined}

Parameters:

Name	Type	Description
`req`	type
`res`	type

To Do:

Describe function

Returns:

Type: undefined

getOrganisation(sridopt, req, res) → {json}

Get the settings for the organisation from the database based on the database connection defined in config.json or config.default.json

Routes:

/api/organisation.json

Parameters:

Name	Type	Attributes	Default	Description
`srid`	integer	<optional>	4326	The EPSG projection for geometry
`req`	Request			Express request object
`res`	Response			Express response object

Returns:

Express res.json()

Type: json

getSite(id, sridopt, req, res) → {json}

Select a Site

Routes:

Parameters:

Name	Type	Attributes	Default	Description
`id`	integer			id for the Site
`srid`	integer	<optional>	4326	The EPSG projection for geometry
`req`	Request			Express request object
`res`	Response			Express response object

Returns:

Express res.json()

Type: json

getSites(sridopt, req, res) → {json}

Get an array containing all Sites with limited properties

Routes:

Parameters:

Name	Type	Attributes	Default	Description
`srid`	integer	<optional>	4326	The EPSG projection for geometry
`req`	Request			Express request object
`res`	Response			Express response object

Returns:

Express res.json()

Type: json

getTerrain(id, sridopt, req, res) → {json}

Select a Terrain

Routes:

Parameters:

Name	Type	Attributes	Default	Description
`id`	integer			id for the Terrain
`srid`	integer	<optional>	4326	The EPSG projection for geometry
`req`	Request			Express request object
`res`	Response			Express response object

Returns:

Express res.json()

Type: json

nen1414() → {text/html}

Render nen1414 symbol information page

Routes:

/nen1414.html

Returns:

Type: text/html

reversegeocode(req, res) → {undefined}

Reverse - Pass coordinates to nominatim and process the result see

Parameters:

Name	Type	Description
`req`	type
`res`	type

Returns:

Type: undefined