openapi: 3.0.2 info: title: Planet Features API version: '1' description: An API to manage features on the Planet platform. servers: - url: https://api.planet.com/features/v1/ogc/my description: My Dataset tags: - name: Capabilities description: API characteristics - name: Collections description: access to feature collections - name: Features description: access to features - name: Tiles description: access to map vector tiles for web rendering paths: /: get: tags: - Capabilities summary: Get Landing Page description: |- The landing page provides links to the API definition, the conformance statements and to the feature collections in this dataset. responses: '200': $ref: '#/components/responses/LandingPage' '500': $ref: '#/components/responses/ServerError' /conformance: get: tags: - Capabilities summary: Get API Conformance description: |- A list of all conformance classes specified in a standard that the server conforms to. responses: '200': $ref: '#/components/responses/ConformanceDeclaration' '500': $ref: '#/components/responses/ServerError' /collections: get: tags: - Collections summary: List Collections description: >- List all feature collections available to the authenticated user in the dataset. Collections can be filtered using text filters (title, description, hashid) and custom properties. All filters are combined with AND logic. parameters: - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - name: title in: query description: >- Filter by collection title. Use prefix ~ for substring matching (e.g., ?title=~my) required: false schema: type: string - name: description in: query description: >- Filter by collection description. Use prefix ~ for substring matching required: false schema: type: string - name: hashid in: query description: >- Filter by collection hashid (immutable internal identifier). See identifiers documentation. required: false schema: type: string - name: sort in: query description: >- Sort results by field. Supported fields are created_date and title. Prefix '-' for descending (e.g., -created_date) required: false schema: type: string enum: - created_date - '-created_date' - title - '-title' responses: '200': $ref: '#/components/responses/Collections' '500': $ref: '#/components/responses/ServerError' post: tags: - Collections summary: Create Collection description: Create a new feature collection in the dataset. requestBody: content: application/json: schema: $ref: '#/components/schemas/Collection' responses: '201': $ref: '#/components/responses/Collection' '500': $ref: '#/components/responses/ServerError' /collections/alternates: post: tags: - Alternates summary: Get Alternates description: >- 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) parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/featureGeoJSON' responses: '200': $ref: '#/components/responses/Features' /collections/validate: post: tags: - Validate summary: Validate Feature description: >- Validate a feature or feature collection against this dataset's lint rules. parameters: [] requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/featureGeoJSON' - $ref: '#/components/schemas/featureCollectionGeoJSON' responses: '200': description: The feature is valid '400': description: Feature geometry does not pass lint rules /collections/{collectionId}: get: tags: - Collections summary: Get Collection description: Get a feature collection by `collectionId` parameters: - $ref: '#/components/parameters/collectionId' responses: '200': $ref: '#/components/responses/Collection' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/ServerError' put: tags: - Collections summary: Update Collection description: Update the feature collection by `collectionId` parameters: - $ref: '#/components/parameters/collectionId' requestBody: content: application/json: schema: $ref: '#/components/schemas/Collection' responses: '200': $ref: '#/components/responses/Collection' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/ServerError' delete: tags: - Collections summary: Delete Collection description: Delete an existing feature collection parameters: - $ref: '#/components/parameters/collectionId' responses: '204': description: The resource was deleted successfully '404': $ref: '#/components/responses/NotFound' /collections/{collectionId}/permission: get: tags: - Collections summary: List Collection Permissions description: List permissions for the feature collection by `collectionId` parameters: - $ref: '#/components/parameters/collectionId' responses: '200': $ref: '#/components/responses/CollectionPermission' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/ServerError' post: tags: - Collections summary: Update Collection Permissions description: Share this collection with your org. parameters: - $ref: '#/components/parameters/collectionId' responses: '204': description: The permissions were updated successfully '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/ServerError' delete: tags: - Collections summary: Delete Collection Permissions description: Unshare a collection. parameters: - $ref: '#/components/parameters/collectionId' responses: '204': description: The permissions were deleted successfully '404': $ref: '#/components/responses/NotFound' /collections/{collectionId}/items: get: tags: - Features summary: List Features description: >- List features of the feature collection with `collectionId`. Every feature in a dataset belongs to a collection. A dataset may consist of multiple feature collections. A feature collection is often a collection of features of a similar type, based on a common schema. Features can be filtered by ID, hashid, custom properties, and geometry (bbox). Any query parameter not in the reserved list is treated as a property filter on the feature's properties. Use prefix ~ in values for substring matching. Use content negotiation to request HTML or GeoJSON. parameters: - $ref: '#/components/parameters/collectionId' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' - $ref: '#/components/parameters/bbox' - name: id in: query description: >- Filter by feature ID. Use prefix ~ for substring matching (e.g., ?id=~test) required: false schema: type: string - name: hashid in: query description: Filter by feature hashid (immutable internal identifier) required: false schema: type: string - name: sort in: query description: >- Sort results by field. Supported field is id. Prefix '-' for descending (e.g., -id) required: false schema: type: string enum: - id - '-id' - name: _view in: query description: >- Response format. 'items' (default) returns full features, 'wkb64' returns geometry as WKB base64-encoded, 'basic' excludes geometry, 'refs' returns minimal reference info required: false schema: type: string enum: - items - wkb64 - basic - refs responses: '200': $ref: '#/components/responses/Features' '400': $ref: '#/components/responses/InvalidParameter' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/ServerError' post: tags: - Features summary: Add Feature description: Add a feature to the collection parameters: - $ref: '#/components/parameters/collectionId' - $ref: '#/components/parameters/parameters-limit' - $ref: '#/components/parameters/parameters-bbox' - $ref: '#/components/parameters/datetime' - name: property_id in: query description: Inform Features API how to extract the id from the feature required: false schema: type: string requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/featureGeoJSON' - $ref: '#/components/schemas/featureCollectionGeoJSON' responses: '201': description: The features were added successfully '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/ServerError' /collections/{collectionId}/items/{featureId}: get: tags: - Features summary: Get Feature description: |- Get a single feature with id `featureId` in the feature collection with id `collectionId`. Use content negotiation to request HTML or GeoJSON. parameters: - $ref: '#/components/parameters/collectionId' - $ref: '#/components/parameters/featureId' responses: '200': $ref: '#/components/responses/Feature' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/ServerError' put: tags: - Features summary: Update Feature description: Update a feature, you cannot update a feature geometry. parameters: - $ref: '#/components/parameters/collectionId' - $ref: '#/components/parameters/featureId' requestBody: content: application/json: schema: $ref: '#/components/schemas/FeatureUpdate' application/octet-stream: schema: type: string format: binary responses: '200': $ref: '#/components/responses/Feature' delete: tags: - Features summary: Delete Feature description: Deletes a feature parameters: - $ref: '#/components/parameters/collectionId' - $ref: '#/components/parameters/featureId' responses: '204': description: Feature was deleted successfully /collections/{collectionId}/tiles/{z}/{x}/{y}: get: tags: - Tiles summary: Get MVT Tile description: >- Get a MapBox Vector Tile (MVT) for the specified collection and tile coordinates. MVT is a compact binary format optimized for efficient web map rendering. Tiles use the Web Mercator (EPSG:3857) projection with coordinates in the XYZ tiling scheme. Maximum zoom level is 22. parameters: - $ref: '#/components/parameters/collectionId' - name: z in: path description: Zoom level (0-22) required: true schema: type: integer minimum: 0 maximum: 22 - name: x in: path description: Tile column coordinate required: true schema: type: integer minimum: 0 - name: 'y' in: path description: Tile row coordinate required: true schema: type: integer minimum: 0 - name: properties in: query description: >- When present (any value, including no value), all feature properties are included in the tile attributes. By default only `title` and `description` are included. required: false allowEmptyValue: true schema: type: string responses: '200': description: MapBox Vector Tile in binary format content: application/octet-stream: schema: type: string format: binary '400': description: Invalid tile coordinates (e.g., zoom > 22) '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/ServerError' components: securitySchemes: JWT: type: http scheme: bearer description: >- Provide {JWT} token in a header like this: `Authorization: Bearer {JWT}`. BasicAuth: type: http scheme: basic schemas: Collection: description: title and optionally a description for Collection type: object required: - title properties: title: type: string description: type: string FeatureUpdate: description: All properties are optional, geometry cannot be updated. type: object properties: properties: type: object link: type: object required: - href properties: href: type: string example: http://data.example.com/buildings/123 rel: type: string example: alternate type: type: string example: application/geo+json hreflang: type: string example: en title: type: string example: Trierer Strasse 70, 53115 Bonn length: type: integer landingPage: type: object required: - links properties: title: type: string example: Buildings in Bonn description: type: string example: >- Access to data about buildings in the city of Bonn via a Web API that conforms to the OGC API Features specification. links: type: array items: $ref: '#/components/schemas/link' exception: type: object description: >- Information about the exception: an error code plus an optional description. required: - code properties: code: type: string description: type: string confClasses: type: object required: - conformsTo properties: conformsTo: type: array items: type: string extent: type: object description: >- The extent of the features in the collection. In the Core only spatial and temporal extents are specified. Extensions may add additional members to represent other extents, for example, thermal or pressure ranges. properties: spatial: description: The spatial extent of the features in the collection. type: object properties: bbox: description: >- One or more bounding boxes that describe the spatial extent of the dataset. In the Core only a single bounding box is supported. Extensions may support additional areas. If multiple areas are provided, the union of the bounding boxes describes the spatial extent. type: array minItems: 1 items: description: >- Each bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (height or depth): * Lower left corner, coordinate axis 1 * Lower left corner, coordinate axis 2 * Minimum value, coordinate axis 3 (optional) * Upper right corner, coordinate axis 1 * Upper right corner, coordinate axis 2 * Maximum value, coordinate axis 3 (optional) The coordinate reference system of the values is WGS 84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate reference system is specified in `crs`. For WGS 84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge). If the vertical axis is included, the third and the sixth number are the bottom and the top of the 3-dimensional bounding box. If a feature has multiple spatial geometry properties, it is the decision of the server whether only a single spatial geometry property is used to determine the extent or all relevant geometries. type: array oneOf: - minItems: 4 maxItems: 4 - minItems: 6 maxItems: 6 items: type: number example: - -180 - -90 - 180 - 90 crs: description: >- Coordinate reference system of the coordinates in the spatial extent (property `bbox`). The default reference system is WGS 84 longitude/latitude. In the Core this is the only supported coordinate reference system. Extensions may support additional coordinate reference systems and add additional enum values. type: string enum: - http://www.opengis.net/def/crs/OGC/1.3/CRS84 default: http://www.opengis.net/def/crs/OGC/1.3/CRS84 temporal: description: The temporal extent of the features in the collection. type: object properties: interval: description: >- One or more time intervals that describe the temporal extent of the dataset. The value `null` is supported and indicates an unbounded interval end. In the Core only a single time interval is supported. Extensions may support multiple intervals. If multiple intervals are provided, the union of the intervals describes the temporal extent. type: array minItems: 1 items: description: >- Begin and end times of the time interval. The timestamps are in the temporal coordinate reference system specified in `trs`. By default this is the Gregorian calendar. type: array minItems: 2 maxItems: 2 items: type: string format: date-time nullable: true example: - '2011-11-11T12:22:11Z' - null trs: description: >- Coordinate reference system of the coordinates in the temporal extent (property `interval`). The default reference system is the Gregorian calendar. In the Core this is the only supported temporal coordinate reference system. Extensions may support additional temporal coordinate reference systems and add additional enum values. type: string enum: - http://www.opengis.net/def/uom/ISO-8601/0/Gregorian default: http://www.opengis.net/def/uom/ISO-8601/0/Gregorian collection: type: object required: - id - links properties: id: description: identifier of the collection used, for example, in URIs type: string example: address title: description: human readable title of the collection type: string example: address description: description: a description of the features in the collection type: string example: An address. links: type: array items: $ref: '#/components/schemas/link' example: - href: http://data.example.com/buildings rel: item - href: http://example.com/concepts/buildings.html rel: describedby type: text/html extent: $ref: '#/components/schemas/extent' itemType: description: >- indicator about the type of the items in the collection (the default value is 'feature'). type: string default: feature crs: description: the list of coordinate reference systems supported by the service type: array items: type: string default: - http://www.opengis.net/def/crs/OGC/1.3/CRS84 example: - http://www.opengis.net/def/crs/OGC/1.3/CRS84 - http://www.opengis.net/def/crs/EPSG/0/4326 collections: type: object required: - links - collections properties: links: type: array items: $ref: '#/components/schemas/link' collections: type: array items: $ref: '#/components/schemas/collection' pointGeoJSON: type: object required: - type - coordinates properties: type: type: string enum: - Point coordinates: type: array minItems: 2 items: type: number multipointGeoJSON: type: object required: - type - coordinates properties: type: type: string enum: - MultiPoint coordinates: type: array items: type: array minItems: 2 items: type: number linestringGeoJSON: type: object required: - type - coordinates properties: type: type: string enum: - LineString coordinates: type: array minItems: 2 items: type: array minItems: 2 items: type: number multilinestringGeoJSON: type: object required: - type - coordinates properties: type: type: string enum: - MultiLineString coordinates: type: array items: type: array minItems: 2 items: type: array minItems: 2 items: type: number polygonGeoJSON: type: object required: - type - coordinates properties: type: type: string enum: - Polygon coordinates: type: array items: type: array minItems: 4 items: type: array minItems: 2 items: type: number multipolygonGeoJSON: type: object required: - type - coordinates properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array minItems: 4 items: type: array minItems: 2 items: type: number geometryGeoJSON: oneOf: - $ref: '#/components/schemas/pointGeoJSON' - $ref: '#/components/schemas/multipointGeoJSON' - $ref: '#/components/schemas/linestringGeoJSON' - $ref: '#/components/schemas/multilinestringGeoJSON' - $ref: '#/components/schemas/polygonGeoJSON' - $ref: '#/components/schemas/multipolygonGeoJSON' - $ref: '#/components/schemas/geometrycollectionGeoJSON' geometrycollectionGeoJSON: type: object required: - type - geometries properties: type: type: string enum: - GeometryCollection geometries: type: array items: $ref: '#/components/schemas/geometryGeoJSON' featureGeoJSON: type: object required: - type - geometry - properties properties: type: type: string enum: - Feature geometry: $ref: '#/components/schemas/geometryGeoJSON' properties: type: object nullable: true id: oneOf: - type: string - type: integer links: type: array items: $ref: '#/components/schemas/link' timeStamp: description: >- This property indicates the time and date when the response was generated. type: string format: date-time example: '2017-08-17T08:05:32Z' numberMatched: description: |- The number of features of the feature type that match the selection parameters like `bbox`. type: integer minimum: 0 example: 127 numberReturned: description: |- 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. type: integer minimum: 0 example: 10 featureCollectionGeoJSON: type: object required: - type - features properties: type: type: string enum: - FeatureCollection features: type: array items: $ref: '#/components/schemas/featureGeoJSON' links: type: array items: $ref: '#/components/schemas/link' timeStamp: $ref: '#/components/schemas/timeStamp' numberMatched: $ref: '#/components/schemas/numberMatched' numberReturned: $ref: '#/components/schemas/numberReturned' parameters: limit: name: limit in: query description: >- The optional limit parameter limits the number of items that are presented in the response document. required: false schema: type: integer minimum: 1 maximum: 500 default: 50 style: form explode: false offset: name: offset in: query description: Pagination offset (number of items to skip) required: false schema: type: integer minimum: 0 default: 0 bbox: name: bbox in: query description: >- Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four numbers: * Lower left corner, coordinate axis 1 * Lower left corner, coordinate axis 2 * Upper right corner, coordinate axis 1 * Upper right corner, coordinate axis 2 The coordinate reference system is WGS 84 degrees longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) required: false schema: type: array oneOf: - minItems: 4 maxItems: 4 items: type: number style: form explode: false collectionId: name: collectionId in: path description: local identifier of a collection required: true schema: type: string parameters-limit: name: limit in: query description: >- The optional limit parameter limits the number of items that are presented in the response document. Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items shall not be counted. Minimum = 1. Maximum = 10000. Default = 10. required: false schema: type: integer minimum: 1 maximum: 10000 default: 10 style: form explode: false parameters-bbox: name: bbox in: query description: >- Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (height or depth): * Lower left corner, coordinate axis 1 * Lower left corner, coordinate axis 2 * Minimum value, coordinate axis 3 (optional) * Upper right corner, coordinate axis 1 * Upper right corner, coordinate axis 2 * Maximum value, coordinate axis 3 (optional) If the value consists of four numbers, the coordinate reference system is WGS 84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate reference system is specified in the parameter `bbox-crs`. If the value consists of six numbers, the coordinate reference system is WGS 84 longitude/latitude/ellipsoidal height (http://www.opengis.net/def/crs/OGC/0/CRS84h) unless a different coordinate reference system is specified in the parameter `bbox-crs`. The query parameter `bbox-crs` is specified in OGC API - Features - Part 2: Coordinate Reference Systems by Reference. For WGS 84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge). If the vertical axis is included, the third and the sixth number are the bottom and the top of the 3-dimensional bounding box. If a feature has multiple spatial geometry properties, it is the decision of the server whether only a single spatial geometry property is used to determine the extent or all relevant geometries. required: false schema: type: array oneOf: - minItems: 4 maxItems: 4 - minItems: 6 maxItems: 6 items: type: number style: form explode: false datetime: name: datetime in: query description: >- Either a date-time or an interval. Date and time expressions adhere to RFC 3339. Intervals may be bounded or half-bounded (double-dots at start or end). Examples: * A date-time: "2018-02-12T23:20:50Z" * A bounded interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" * Half-bounded intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z" Only features that have a temporal property that intersects the value of `datetime` are selected. If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties. required: false schema: type: string style: form explode: false featureId: name: featureId in: path description: local identifier of a feature required: true schema: type: string responses: CollectionPermission: description: Permission Response content: application/json: schema: type: object properties: can_read: type: boolean can_write: type: boolean LandingPage: description: |- The landing page provides links to the API definition (link relations `service-desc` and `service-doc`), the Conformance declaration (path `/conformance`, link relation `conformance`), and the Feature Collections (path `/collections`, link relation `data`). content: application/json: schema: $ref: '#/components/schemas/landingPage' example: title: Buildings in Bonn description: >- Access to data about buildings in the city of Bonn via a Web API that conforms to the OGC API Features specification. links: - href: http://data.example.org/ rel: self type: application/json title: this document - href: http://data.example.org/api rel: service-desc type: application/vnd.oai.openapi+json;version=3.0 title: the API definition - href: http://data.example.org/api.html rel: service-doc type: text/html title: the API documentation - href: http://data.example.org/conformance rel: conformance type: application/json title: OGC API conformance classes implemented by this server - href: http://data.example.org/collections rel: data type: application/json title: Information about the feature collections text/html: schema: type: string ServerError: description: A server error occurred. content: application/json: schema: $ref: '#/components/schemas/exception' text/html: schema: type: string ConformanceDeclaration: description: |- The URIs of all conformance classes supported by the server. To support "generic" clients that want to access multiple OGC API Features implementations - and not "just" a specific API / server, the server declares the conformance classes it implements and conforms to. content: application/json: schema: $ref: '#/components/schemas/confClasses' example: conformsTo: - http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/core - http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/oas30 - http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/html - http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/geojson text/html: schema: type: string Collections: description: >- The feature collections shared by this API. The dataset is organized as one or more feature collections. This resource provides information about and access to the collections. The response contains the list of collections. For each collection, a link to the items in the collection (path `/collections/{collectionId}/items`, link relation `items`) as well as key information about the collection. This information includes: * A local identifier for the collection that is unique for the dataset; * A list of coordinate reference systems (CRS) in which geometries may be returned by the server. The first CRS is the default coordinate reference system (the default is always WGS 84 with axis order longitude/latitude); * An optional title and description for the collection; * An optional extent that can be used to provide an indication of the spatial and temporal extent of the collection - typically derived from the data; * An optional indicator about the type of the items in the collection (the default value, if the indicator is not provided, is 'feature'). content: application/json: schema: $ref: '#/components/schemas/collections' example: links: - href: http://data.example.org/collections.json rel: self type: application/json title: this document - href: http://data.example.org/collections.html rel: alternate type: text/html title: this document as HTML - href: http://schemas.example.org/1.0/buildings.xsd rel: describedby type: application/xml title: GML application schema for Acme Corporation building data - href: http://download.example.org/buildings.gpkg rel: enclosure type: application/geopackage+sqlite3 title: Bulk download (GeoPackage) length: 472546 collections: - id: buildings title: Buildings description: Buildings in the city of Bonn. extent: spatial: bbox: - - 7.01 - 50.63 - 7.22 - 50.78 temporal: interval: - - '2010-02-15T12:34:56Z' - null links: - href: http://data.example.org/collections/buildings/items rel: items type: application/geo+json title: Buildings - href: http://data.example.org/collections/buildings/items.html rel: items type: text/html title: Buildings - href: https://creativecommons.org/publicdomain/zero/1.0/ rel: license type: text/html title: CC0-1.0 - href: https://creativecommons.org/publicdomain/zero/1.0/rdf rel: license type: application/rdf+xml title: CC0-1.0 text/html: schema: type: string Collection: description: >- Information about the feature collection with id `collectionId`. The response contains a link to the items in the collection (path `/collections/{collectionId}/items`, link relation `items`) as well as key information about the collection. This information includes: * A local identifier for the collection that is unique for the dataset; * A list of coordinate reference systems (CRS) in which geometries may be returned by the server. The first CRS is the default coordinate reference system (the default is always WGS 84 with axis order longitude/latitude); * An optional title and description for the collection; * An optional extent that can be used to provide an indication of the spatial and temporal extent of the collection - typically derived from the data; * An optional indicator about the type of the items in the collection (the default value, if the indicator is not provided, is 'feature'). content: application/json: schema: $ref: '#/components/schemas/collection' example: id: buildings title: Buildings description: Buildings in the city of Bonn. extent: spatial: bbox: - - 7.01 - 50.63 - 7.22 - 50.78 temporal: interval: - - '2010-02-15T12:34:56Z' - null links: - href: http://data.example.org/collections/buildings/items rel: items type: application/geo+json title: Buildings - href: http://data.example.org/collections/buildings/items.html rel: items type: text/html title: Buildings - href: https://creativecommons.org/publicdomain/zero/1.0/ rel: license type: text/html title: CC0-1.0 - href: https://creativecommons.org/publicdomain/zero/1.0/rdf rel: license type: application/rdf+xml title: CC0-1.0 text/html: schema: type: string Features: description: >- 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`). content: application/geo+json: schema: $ref: '#/components/schemas/featureCollectionGeoJSON' example: type: FeatureCollection links: - href: http://data.example.com/collections/buildings/items.json rel: self type: application/geo+json title: this document - href: http://data.example.com/collections/buildings/items.html rel: alternate type: text/html title: this document as HTML - href: >- http://data.example.com/collections/buildings/items.json&offset=10&limit=2 rel: next type: application/geo+json title: next page timeStamp: '2018-04-03T14:52:23Z' numberMatched: 123 numberReturned: 2 features: - type: Feature id: '123' geometry: type: Polygon coordinates: - ... properties: function: residential floors: '2' lastUpdate: '2015-08-01T12:34:56Z' - type: Feature id: '132' geometry: type: Polygon coordinates: - ... properties: function: public use floors: '10' lastUpdate: '2013-12-03T10:15:37Z' text/html: schema: type: string NotFound: description: >- The requested resource does not exist on the server. For example, a path parameter had an incorrect value. InvalidParameter: description: A query parameter has an invalid value. content: application/json: schema: $ref: '#/components/schemas/exception' text/html: schema: type: string Feature: description: |- fetch the feature with id `featureId` in the feature collection with id `collectionId` content: application/geo+json: schema: $ref: '#/components/schemas/featureGeoJSON' example: type: Feature links: - href: http://data.example.com/id/building/123 rel: canonical title: canonical URI of the building - href: http://data.example.com/collections/buildings/items/123.json rel: self type: application/geo+json title: this document - href: http://data.example.com/collections/buildings/items/123.html rel: alternate type: text/html title: this document as HTML - href: http://data.example.com/collections/buildings rel: collection type: application/geo+json title: the collection document id: '123' geometry: type: Polygon coordinates: - ... properties: function: residential floors: '2' lastUpdate: '2015-08-01T12:34:56Z' text/html: schema: type: string security: - JWT: [] - BasicAuth: []