Search
Searches the records the platform holds for a plain term, as a case-insensitive substring over each record's names, a site's waterway and the numbers that identify it, and optionally narrowed to the kinds stated in 'type'. Results are ordered by kind in the declared order, then by name, with the id as the tiebreaker, so a page is deterministic across calls. There is no relevance ranking and none is claimed, because the platform holds nothing to rank on. The read is not a read-after-write surface.
Searches the records the platform holds for a plain term, as a case-insensitive substring over each record's names, a site's waterway and the numbers that identify it, and optionally narrowed to the kinds stated in 'type'. Results are ordered by kind in the declared order, then by name, with the id as the tiebreaker, so a page is deterministic across calls. There is no relevance ranking and none is claimed, because the platform holds nothing to rank on. The read is not a read-after-write surface.
Query Parameters
^-?(?:0|[1-9]\d*)$int321^-?(?:0|[1-9]\d*)$int3210Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/search?q=string"{ "items": [ { "type": "area", "id": "string", "name": "string", "context": null } ], "pageNumber": 0, "pageSize": 0, "totalCount": 0, "totalPages": 0, "hasPreviousPage": true, "hasNextPage": true}