Interface GetGeoParams

Query parameter to specify a geospatial query bounding box with two latitude,longitude coordinates for the lower-left and upper-right corners. An example is -11.05987446,12.28339928,-101.05987446,62.28339928.

Query parameter to specify a bookmark that was received from a previous request. This parameter enables paging through the results. If there are no more results after the bookmark, you get a response containing no further results and the same bookmark, confirming the end of the result list.

Path parameter to specify the database name.

Path parameter to specify the design document name. The design document name is the design document ID excluding the _design/ prefix.

Query parameter that causes the geospatial query output to be returned in the specified format.

Query parameter to specify a Well Known Text (WKT) representation of a geospatial query geometry. The valid values for the WKT parameter include Point, LineString, Polygon, MultiPoint, MultiLineString, MultiPolygon, and GeometryCollection.

Query parameter to specify whether to include the full content of the documents in the response.

Path parameter to specify the index name.

Query parameter to specify a latitude coordinate for use with radius or ellipse geospatial queries.

Query parameter to specify the number of returned documents to limit the result to.

Query parameter to specify a longitude coordinate for use with radius or ellipse geospatial queries.

Query parameter to specify whether to perform a nearest neighbour (NN) search. If provided, the nearest=true search returns all results by sorting their distances to the center of the query geometry. NN search can be used alone or with any of the supported DE-9IM (Dimensionally Extended nine-Intersection Model) specification geometric relations documented.

Query parameter to specify the radius, in meters, to search from a lat,lon coordinate point in a circular geospatial query.

Query parameter to specify the first radius, in meters, to search from a lat,lon coordinate point in an ellipse geospatial query.

Query parameter to specify the second radius, in meters, to search from a lat,lon coordinate point in an ellipse geospatial query.

Query parameter to specify the DE-9IM (Dimensionally Extended nine-Intersection Model)geospatial relationship between the query geometry and the result documents.

Query parameter to specify the number of records before starting to return the results.

Query parameter to specify to not wait for the index to finish building before returning results.