A full-text search ViewSet.

  • Example: </api/v3/search/?q=water>_
  • Example: </api/v3/search/?type=assetgroup,eventseries>_
  • Example: </api/v3/search/?exclude=ef34gh3>_
  • Example: </api/v3/search/?q=water&in_bbox=4.6,52.1,5.2,52.5&srid=4326>_
  • Example: </api/v3/search/?q=water&point=POINT (5 53)&dist=10000>_

Parameters:

q Optional full-text search filter limited to: bridges, culverts, groundwater stations, levees, levee cross sections, measuring stations, monitoring wells, pressure pipes, pump stations, sluices, waste water treatment plants, and weirs. A search query filter should at least contain two characters.

in_bbox Optional comma-separated string of a bounding-box, of the form: "xmin,ymin,xmax,ymax".

dist Optional Distance in meters.

point Optional point geometry (either WKT or GeoJSON).

srid Optional Spatial Reference System Identifier.

type Optional experimental in v2 comma-seperated list of entity types. Currently the only way to search for layer metadata is by explicitly requesting those entities: type=rasterstore,scenario,assetlayer. It may also be used to limit search results to specific types, i.e. type=levees.

exclude Optional experimental in v2 comma-seperated list of exclude terms. Results are excluded if the url of the resource contains a term. This is done in the viewset so the serializer still respects the requested page_size.

GET /api/v3/search/
HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 0,
    "next": null,
    "previous": null,
    "results": []
}