Alternates

Get Alternates

generate alternate geometries for features with vertex count that exceeds the vertex limit or may be invalid (e.g via de-duping, simpplification, bbox, convex hull, etc)

post/collections/alternates

Request

Request body

type'Feature' required
propertiesobject nullable required

Example request

{
  "links": [
    {
      "href": "http://data.example.com/buildings/123",
      "rel": "alternate",
      "type": "application/geo+json",
      "hreflang": "en",
      "title": "Trierer Strasse 70, 53115 Bonn"
    }
  ]
}

Response

The response is a document consisting of features in the collection. The features included in the response are determined by the server based on the query parameters of the request. To support access to larger collections without overloading the client, the API supports paged access with links to the next page, if more features are selected that the page size.

The bbox and datetime parameter can be used to select only a subset of the features in the collection (the features that are in the bounding box or time interval). The bbox parameter matches all features in the collection that are not associated with a location, too. The datetime parameter matches all features in the collection that are not associated with a time stamp or interval, too.

The limit parameter may be used to control the subset of the selected features that should be returned in the response, the page size. Each page may include information about the number of selected and returned features (numberMatched and numberReturned) as well as links to support paging (link relation next).

type'FeatureCollection' required
timeStampstring date-time

This property indicates the time and date when the response was generated.

numberMatchedinteger

The number of features of the feature type that match the selection parameters like bbox.

numberReturnedinteger

The number of features in the feature collection.

A server may omit this information in a response, if the information about the number of features is not known or difficult to compute.

If the value is provided, the value shall be identical to the number of items in the "features" array.

Example response

{
  "features": [
    {
      "links": [
        {
          "href": "http://data.example.com/buildings/123",
          "rel": "alternate",
          "type": "application/geo+json",
          "hreflang": "en",
          "title": "Trierer Strasse 70, 53115 Bonn"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "http://data.example.com/buildings/123",
      "rel": "alternate",
      "type": "application/geo+json",
      "hreflang": "en",
      "title": "Trierer Strasse 70, 53115 Bonn"
    }
  ],
  "timeStamp": "2017-08-17T08:05:32Z",
  "numberMatched": 127,
  "numberReturned": 10
}

Changes

No recorded changes to this operation across all 1 revision of this API.