FastAPI 0.1.0¶
Core¶
GET /¶
landing page
Description
...
Response 200 OK
{
"conformsTo": [
"string"
],
"description": "string",
"id": "string",
"links": [
{
"body": null,
"headers": {},
"href": "string",
"merge": true,
"method": "GET",
"rel": "string",
"title": "string",
"type": "string"
}
],
"title": "string"
}
Schema of the response body
{
"properties": {
"conformsTo": {
"items": {
"type": "string"
},
"title": "Conformsto",
"type": "array"
},
"description": {
"title": "Description",
"type": "string"
},
"id": {
"title": "Id",
"type": "string"
},
"links": {
"items": {
"$ref": "#/components/schemas/Link"
},
"title": "Links",
"type": "array"
},
"title": {
"title": "Title",
"type": "string"
}
},
"required": [
"conformsTo",
"id",
"description",
"links"
],
"title": "RootResponse",
"type": "object"
}
GET /conformance¶
information about specifications that this API conforms to
Description
A list of all conformance classes specified in a standard that the server conforms to.
Response 200 OK
{
"conformsTo": [
"string"
]
}
Schema of the response body
{
"properties": {
"conformsTo": {
"items": {
"type": "string"
},
"title": "Conformsto",
"type": "array"
}
},
"required": [
"conformsTo"
],
"title": "Conformance",
"type": "object"
}
Orders¶
GET /orders¶
a list of orders
Description
...
Response 200 OK
{
"bbox": null,
"features": [
{
"bbox": null,
"created": "2022-04-13T15:42:05.901Z",
"geometry": null,
"id": "string",
"links": [
{
"body": null,
"headers": {},
"href": "string",
"merge": true,
"method": "GET",
"rel": "string",
"title": "string",
"type": "string"
}
],
"properties": {
"created": "2022-04-13T15:42:05.901Z",
"opportunity_properties": {},
"order_parameters": {},
"product_id": "string",
"search_parameters": {
"datetime": "string",
"filter": null,
"geometry": null
},
"status": {
"links": null,
"reason_code": null,
"reason_text": null,
"status_code": "received",
"timestamp": "2022-04-13T15:42:05.901Z"
}
},
"stapi_type": "string",
"stapi_version": "string",
"status": null,
"type": "string",
"user": "string"
}
],
"links": null,
"type": "string"
}
Schema of the response body
{
"properties": {
"bbox": {
"anyOf": [
{
"maxItems": 4,
"minItems": 4,
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array"
},
{
"maxItems": 6,
"minItems": 6,
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array"
},
{
"type": "null"
}
],
"title": "Bbox"
},
"features": {
"items": {
"$ref": "#/components/schemas/Order_OrderStatus_"
},
"title": "Features",
"type": "array"
},
"links": {
"items": {
"$ref": "#/components/schemas/Link"
},
"title": "Links",
"type": "array"
},
"type": {
"const": "FeatureCollection",
"default": "FeatureCollection",
"title": "Type",
"type": "string"
}
},
"required": [
"features"
],
"title": "OrderCollection[OrderStatus]",
"type": "object"
}
GET /orders/{orderId}¶
describe the order with id orderId
Description
...
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
orderId |
path | string | No | local identifier of an order |
Response 200 OK
{
"bbox": null,
"created": "2022-04-13T15:42:05.901Z",
"geometry": null,
"id": "string",
"links": [
{
"body": null,
"headers": {},
"href": "string",
"merge": true,
"method": "GET",
"rel": "string",
"title": "string",
"type": "string"
}
],
"properties": {
"created": "2022-04-13T15:42:05.901Z",
"opportunity_properties": {},
"order_parameters": {},
"product_id": "string",
"search_parameters": {
"datetime": "string",
"filter": null,
"geometry": null
},
"status": {
"links": null,
"reason_code": null,
"reason_text": null,
"status_code": "received",
"timestamp": "2022-04-13T15:42:05.901Z"
}
},
"stapi_type": "string",
"stapi_version": "string",
"status": null,
"type": "string",
"user": "string"
}
Schema of the response body
{
"properties": {
"bbox": {
"anyOf": [
{
"maxItems": 4,
"minItems": 4,
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array"
},
{
"maxItems": 6,
"minItems": 6,
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array"
},
{
"type": "null"
}
],
"title": "Bbox"
},
"created": {
"format": "date-time",
"title": "Created",
"type": "string"
},
"geometry": {
"discriminator": {
"mapping": {
"GeometryCollection": "#/components/schemas/GeometryCollection-Output",
"LineString": "#/components/schemas/LineString",
"MultiLineString": "#/components/schemas/MultiLineString",
"MultiPoint": "#/components/schemas/MultiPoint",
"MultiPolygon": "#/components/schemas/MultiPolygon",
"Point": "#/components/schemas/Point",
"Polygon": "#/components/schemas/Polygon"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/Point"
},
{
"$ref": "#/components/schemas/MultiPoint"
},
{
"$ref": "#/components/schemas/LineString"
},
{
"$ref": "#/components/schemas/MultiLineString"
},
{
"$ref": "#/components/schemas/Polygon"
},
{
"$ref": "#/components/schemas/MultiPolygon"
},
{
"$ref": "#/components/schemas/GeometryCollection-Output"
}
],
"title": "Geometry"
},
"id": {
"title": "Id",
"type": "string"
},
"links": {
"items": {
"$ref": "#/components/schemas/Link"
},
"title": "Links",
"type": "array"
},
"properties": {
"$ref": "#/components/schemas/OrderProperties_OrderStatus_"
},
"stapi_type": {
"const": "Order",
"default": "Order",
"title": "Stapi Type",
"type": "string"
},
"stapi_version": {
"default": "0.1.0",
"title": "Stapi Version",
"type": "string"
},
"status": {
"$ref": "#/components/schemas/OrderStatus",
"title": "Status"
},
"type": {
"const": "Feature",
"default": "Feature",
"title": "Type",
"type": "string"
},
"user": {
"title": "User",
"type": "string"
}
},
"required": [
"geometry",
"properties"
],
"title": "Order[OrderStatus]",
"type": "object"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /orders/{orderId}/statuses¶
describe the statuses that the order with id orderId has had
Description
...
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
limit |
query | integer | 10 | No | |
next |
query | None | No | ||
order_id |
query | string | No |
Response 200 OK
{
"links": [
{
"body": null,
"headers": {},
"href": "string",
"merge": true,
"method": "GET",
"rel": "string",
"title": "string",
"type": "string"
}
],
"statuses": [
{
"links": null,
"reason_code": null,
"reason_text": null,
"status_code": "received",
"timestamp": "2022-04-13T15:42:05.901Z"
}
]
}
Schema of the response body
{
"properties": {
"links": {
"items": {
"$ref": "#/components/schemas/Link"
},
"title": "Links",
"type": "array"
},
"statuses": {
"items": {
"$ref": "#/components/schemas/OrderStatus"
},
"title": "Statuses",
"type": "array"
}
},
"required": [
"statuses"
],
"title": "OrderStatuses",
"type": "object"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
GET /products/{productId}/orders¶
get a list of orders for the specific product
Description
...
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
limit |
query | integer | 10 | No | |
next |
query | None | No |
Response 200 OK
{
"bbox": null,
"features": [
{
"bbox": null,
"created": "2022-04-13T15:42:05.901Z",
"geometry": null,
"id": "string",
"links": [
{
"body": null,
"headers": {},
"href": "string",
"merge": true,
"method": "GET",
"rel": "string",
"title": "string",
"type": "string"
}
],
"properties": {
"created": "2022-04-13T15:42:05.901Z",
"opportunity_properties": {},
"order_parameters": {},
"product_id": "string",
"search_parameters": {
"datetime": "string",
"filter": null,
"geometry": null
},
"status": {
"links": null,
"reason_code": null,
"reason_text": null,
"status_code": "received",
"timestamp": "2022-04-13T15:42:05.901Z"
}
},
"stapi_type": "string",
"stapi_version": "string",
"status": null,
"type": "string",
"user": "string"
}
],
"links": null,
"type": "string"
}
Schema of the response body
{
"properties": {
"bbox": {
"anyOf": [
{
"maxItems": 4,
"minItems": 4,
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array"
},
{
"maxItems": 6,
"minItems": 6,
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array"
},
{
"type": "null"
}
],
"title": "Bbox"
},
"features": {
"items": {
"$ref": "#/components/schemas/Order_OrderStatus_"
},
"title": "Features",
"type": "array"
},
"links": {
"items": {
"$ref": "#/components/schemas/Link"
},
"title": "Links",
"type": "array"
},
"type": {
"const": "FeatureCollection",
"default": "FeatureCollection",
"title": "Type",
"type": "string"
}
},
"required": [
"features"
],
"title": "OrderCollection[OrderStatus]",
"type": "object"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
POST /products/{productId}/orders¶
create a new order for product with id productId
Description
...
Request body
{
"datetime": [],
"filter": null,
"geometry": null,
"order_parameters": {}
}
Schema of the request body
{
"properties": {
"datetime": {
"maxItems": 2,
"minItems": 2,
"prefixItems": [
{
"format": "date-time",
"type": "string"
},
{
"format": "date-time",
"type": "string"
}
],
"title": "Datetime",
"type": "array"
},
"filter": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Filter"
},
"geometry": {
"discriminator": {
"mapping": {
"GeometryCollection": "#/components/schemas/GeometryCollection-Input",
"LineString": "#/components/schemas/LineString",
"MultiLineString": "#/components/schemas/MultiLineString",
"MultiPoint": "#/components/schemas/MultiPoint",
"MultiPolygon": "#/components/schemas/MultiPolygon",
"Point": "#/components/schemas/Point",
"Polygon": "#/components/schemas/Polygon"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/Point"
},
{
"$ref": "#/components/schemas/MultiPoint"
},
{
"$ref": "#/components/schemas/LineString"
},
{
"$ref": "#/components/schemas/MultiLineString"
},
{
"$ref": "#/components/schemas/Polygon"
},
{
"$ref": "#/components/schemas/MultiPolygon"
},
{
"$ref": "#/components/schemas/GeometryCollection-Input"
}
],
"title": "Geometry"
},
"order_parameters": {
"$ref": "#/components/schemas/OrderParameters"
}
},
"required": [
"datetime",
"geometry",
"order_parameters"
],
"title": "OrderPayload",
"type": "object"
}
Response 201 Created
{
"bbox": null,
"created": "2022-04-13T15:42:05.901Z",
"geometry": null,
"id": "string",
"links": [
{
"body": null,
"headers": {},
"href": "string",
"merge": true,
"method": "GET",
"rel": "string",
"title": "string",
"type": "string"
}
],
"properties": {
"created": "2022-04-13T15:42:05.901Z",
"opportunity_properties": {},
"order_parameters": {},
"product_id": "string",
"search_parameters": {
"datetime": "string",
"filter": null,
"geometry": null
},
"status": {
"links": null,
"reason_code": null,
"reason_text": null,
"status_code": "received",
"timestamp": "2022-04-13T15:42:05.901Z"
}
},
"stapi_type": "string",
"stapi_version": "string",
"status": null,
"type": "string",
"user": "string"
}
Schema of the response body
{
"properties": {
"bbox": {
"anyOf": [
{
"maxItems": 4,
"minItems": 4,
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array"
},
{
"maxItems": 6,
"minItems": 6,
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array"
},
{
"type": "null"
}
],
"title": "Bbox"
},
"created": {
"format": "date-time",
"title": "Created",
"type": "string"
},
"geometry": {
"discriminator": {
"mapping": {
"GeometryCollection": "#/components/schemas/GeometryCollection-Output",
"LineString": "#/components/schemas/LineString",
"MultiLineString": "#/components/schemas/MultiLineString",
"MultiPoint": "#/components/schemas/MultiPoint",
"MultiPolygon": "#/components/schemas/MultiPolygon",
"Point": "#/components/schemas/Point",
"Polygon": "#/components/schemas/Polygon"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/Point"
},
{
"$ref": "#/components/schemas/MultiPoint"
},
{
"$ref": "#/components/schemas/LineString"
},
{
"$ref": "#/components/schemas/MultiLineString"
},
{
"$ref": "#/components/schemas/Polygon"
},
{
"$ref": "#/components/schemas/MultiPolygon"
},
{
"$ref": "#/components/schemas/GeometryCollection-Output"
}
],
"title": "Geometry"
},
"id": {
"title": "Id",
"type": "string"
},
"links": {
"items": {
"$ref": "#/components/schemas/Link"
},
"title": "Links",
"type": "array"
},
"properties": {
"$ref": "#/components/schemas/OrderProperties"
},
"stapi_type": {
"const": "Order",
"default": "Order",
"title": "Stapi Type",
"type": "string"
},
"stapi_version": {
"default": "0.1.0",
"title": "Stapi Version",
"type": "string"
},
"status": {
"$ref": "#/components/schemas/OrderStatus",
"title": "Status"
},
"type": {
"const": "Feature",
"default": "Feature",
"title": "Type",
"type": "string"
},
"user": {
"title": "User",
"type": "string"
}
},
"required": [
"geometry",
"properties"
],
"title": "Order",
"type": "object"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
Products¶
GET /products¶
the products in the dataset
Description
...
Response 200 OK
{
"links": [
{
"body": null,
"headers": {},
"href": "string",
"merge": true,
"method": "GET",
"rel": "string",
"title": "string",
"type": "string"
}
],
"products": [
{
"conformsTo": [
"string"
],
"description": "string",
"id": "string",
"keywords": [
"string"
],
"license": "string",
"links": null,
"providers": [
{
"description": "string",
"name": "string",
"roles": [
"producer"
],
"url": "string"
}
],
"stapi_type": "string",
"stapi_version": "string",
"title": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"links": {
"items": {
"$ref": "#/components/schemas/Link"
},
"title": "Links",
"type": "array"
},
"products": {
"description": "STAPI Product objects are represented in JSON format and are very flexible. Any JSON object that contains all the required fields is a valid STAPI Product. A Product object contains a minimal set of required properties to be valid and can be extended through the use of queryables and parameters.",
"items": {
"$ref": "#/components/schemas/Product"
},
"title": "Products",
"type": "array"
}
},
"required": [
"links",
"products"
],
"title": "ProductsCollection",
"type": "object"
}
GET /products/{productId}¶
describe the product with id productId
Description
...
Response 200 OK
{
"conformsTo": [
"string"
],
"description": "string",
"id": "string",
"keywords": [
"string"
],
"license": "string",
"links": [
{
"body": null,
"headers": {},
"href": "string",
"merge": true,
"method": "GET",
"rel": "string",
"title": "string",
"type": "string"
}
],
"providers": [
{
"description": "string",
"name": "string",
"roles": [
"producer"
],
"url": "string"
}
],
"stapi_type": "string",
"stapi_version": "string",
"title": "string",
"type": "string"
}
Schema of the response body
{
"properties": {
"conformsTo": {
"items": {
"type": "string"
},
"title": "Conformsto",
"type": "array"
},
"description": {
"title": "Description",
"type": "string"
},
"id": {
"title": "Id",
"type": "string"
},
"keywords": {
"items": {
"type": "string"
},
"title": "Keywords",
"type": "array"
},
"license": {
"title": "License",
"type": "string"
},
"links": {
"items": {
"$ref": "#/components/schemas/Link"
},
"title": "Links",
"type": "array"
},
"providers": {
"items": {
"$ref": "#/components/schemas/Provider"
},
"title": "Providers",
"type": "array"
},
"stapi_type": {
"const": "Product",
"default": "Product",
"title": "Stapi Type",
"type": "string"
},
"stapi_version": {
"default": "0.1.0",
"title": "Stapi Version",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
},
"type": {
"const": "Collection",
"default": "Collection",
"title": "Type",
"type": "string"
}
},
"required": [
"id",
"description",
"license",
"links"
],
"title": "Product",
"type": "object"
}
GET /products/{productId}/order-parameters¶
describe the order parameters for a product
Description
...
Response 200 OK
Schema of the response body
{
"title": "Response Get Product Order Parameters Products Productid Order Parameters Get",
"type": "object"
}
GET /products/{productId}/queryables¶
describe the queryables for a product
Description
...
Response 200 OK
Schema of the response body
{
"title": "Response Get Product Queryables Products Productid Queryables Get",
"type": "object"
}
Opportunities¶
POST /products/{productId}/opportunities¶
create a new opportunity request for product with id productId
Description
...
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
prefer |
query | None | No |
Request body
{
"datetime": [],
"filter": null,
"geometry": null,
"limit": 0,
"next": null
}
Schema of the request body
{
"properties": {
"datetime": {
"maxItems": 2,
"minItems": 2,
"prefixItems": [
{
"format": "date-time",
"type": "string"
},
{
"format": "date-time",
"type": "string"
}
],
"title": "Datetime",
"type": "array"
},
"filter": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Filter"
},
"geometry": {
"discriminator": {
"mapping": {
"GeometryCollection": "#/components/schemas/GeometryCollection-Input",
"LineString": "#/components/schemas/LineString",
"MultiLineString": "#/components/schemas/MultiLineString",
"MultiPoint": "#/components/schemas/MultiPoint",
"MultiPolygon": "#/components/schemas/MultiPolygon",
"Point": "#/components/schemas/Point",
"Polygon": "#/components/schemas/Polygon"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/Point"
},
{
"$ref": "#/components/schemas/MultiPoint"
},
{
"$ref": "#/components/schemas/LineString"
},
{
"$ref": "#/components/schemas/MultiLineString"
},
{
"$ref": "#/components/schemas/Polygon"
},
{
"$ref": "#/components/schemas/MultiPolygon"
},
{
"$ref": "#/components/schemas/GeometryCollection-Input"
}
],
"title": "Geometry"
},
"limit": {
"default": 10,
"title": "Limit",
"type": "integer"
},
"next": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next"
}
},
"required": [
"datetime",
"geometry"
],
"title": "OpportunityPayload",
"type": "object"
}
Response 200 OK
{
"bbox": null,
"features": [
{
"bbox": null,
"geometry": null,
"id": null,
"links": [
{
"body": null,
"headers": {},
"href": "string",
"merge": true,
"method": "GET",
"rel": "string",
"title": "string",
"type": "string"
}
],
"properties": null,
"type": "string"
}
],
"id": null,
"links": null,
"type": "string"
}
Schema of the response body
{
"properties": {
"bbox": {
"anyOf": [
{
"maxItems": 4,
"minItems": 4,
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array"
},
{
"maxItems": 6,
"minItems": 6,
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array"
},
{
"type": "null"
}
],
"title": "Bbox"
},
"features": {
"items": {
"$ref": "#/components/schemas/Opportunity"
},
"title": "Features",
"type": "array"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"links": {
"items": {
"$ref": "#/components/schemas/Link"
},
"title": "Links",
"type": "array"
},
"type": {
"const": "FeatureCollection",
"default": "FeatureCollection",
"title": "Type",
"type": "string"
}
},
"required": [
"features"
],
"title": "OpportunityCollection",
"type": "object"
}
Response 422 Unprocessable Content
{
"detail": [
{
"loc": [
null
],
"msg": "string",
"type": "string"
}
]
}
Schema of the response body
{
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"title": "Detail",
"type": "array"
}
},
"title": "HTTPValidationError",
"type": "object"
}
Schemas¶
Conformance¶
| Name | Type |
|---|---|
conformsTo |
Array<string> |
GeometryCollection-Input¶
| Name | Type |
|---|---|
bbox |
|
geometries |
Array<> |
type |
string |
GeometryCollection-Output¶
| Name | Type |
|---|---|
bbox |
|
geometries |
Array<> |
type |
string |
HTTPValidationError¶
| Name | Type |
|---|---|
detail |
Array<ValidationError> |
LineString¶
| Name | Type |
|---|---|
bbox |
|
coordinates |
Array<> |
type |
string |
Link¶
| Name | Type |
|---|---|
body |
|
headers |
|
href |
string(uri) |
merge |
boolean |
method |
RequestMethod |
rel |
string |
title |
string |
type |
string |
MultiLineString¶
| Name | Type |
|---|---|
bbox |
|
coordinates |
Array<Array<>> |
type |
string |
MultiPoint¶
| Name | Type |
|---|---|
bbox |
|
coordinates |
Array<> |
type |
string |
MultiPolygon¶
| Name | Type |
|---|---|
bbox |
|
coordinates |
Array<Array<Array<>>> |
type |
string |
Opportunity¶
| Name | Type |
|---|---|
bbox |
|
geometry |
|
id |
|
links |
Array<Link> |
properties |
|
type |
string |
OpportunityCollection¶
| Name | Type |
|---|---|
bbox |
|
features |
Array<Opportunity> |
id |
|
links |
Array<Link> |
type |
string |
OpportunityPayload¶
| Name | Type |
|---|---|
datetime |
Array<> |
filter |
|
geometry |
|
limit |
integer |
next |
OpportunityProperties¶
| Name | Type |
|---|---|
datetime |
string |
product_id |
string |
Order¶
| Name | Type |
|---|---|
bbox |
|
created |
string(date-time) |
geometry |
|
id |
string |
links |
Array<Link> |
properties |
OrderProperties |
stapi_type |
string |
stapi_version |
string |
status |
OrderStatus |
type |
string |
user |
string |
Order_OrderStatus_¶
| Name | Type |
|---|---|
bbox |
|
created |
string(date-time) |
geometry |
|
id |
string |
links |
Array<Link> |
properties |
OrderProperties_OrderStatus_ |
stapi_type |
string |
stapi_version |
string |
status |
OrderStatus |
type |
string |
user |
string |
OrderCollection_OrderStatus_¶
| Name | Type |
|---|---|
bbox |
|
features |
Array<Order_OrderStatus_> |
links |
Array<Link> |
type |
string |
OrderParameters¶
OrderPayload¶
| Name | Type |
|---|---|
datetime |
Array<> |
filter |
|
geometry |
|
order_parameters |
OrderParameters |
OrderProperties¶
| Name | Type |
|---|---|
created |
string(date-time) |
opportunity_properties |
|
order_parameters |
|
product_id |
string |
search_parameters |
OrderSearchParameters |
status |
OrderStatus |
OrderProperties_OrderStatus_¶
| Name | Type |
|---|---|
created |
string(date-time) |
opportunity_properties |
|
order_parameters |
|
product_id |
string |
search_parameters |
OrderSearchParameters |
status |
OrderStatus |
OrderSearchParameters¶
| Name | Type |
|---|---|
datetime |
string |
filter |
|
geometry |
OrderStatus¶
| Name | Type |
|---|---|
links |
Array<Link> |
reason_code |
|
reason_text |
|
status_code |
OrderStatusCode |
timestamp |
string(date-time) |
OrderStatusCode¶
Type: string
OrderStatuses¶
| Name | Type |
|---|---|
links |
Array<Link> |
statuses |
Array<OrderStatus> |
Point¶
| Name | Type |
|---|---|
bbox |
|
coordinates |
|
type |
string |
Polygon¶
| Name | Type |
|---|---|
bbox |
|
coordinates |
Array<Array<>> |
type |
string |
Position2D¶
Type: Array<>
Position3D¶
Type: Array<>
Prefer¶
Type: string
Product¶
| Name | Type |
|---|---|
conformsTo |
Array<string> |
description |
string |
id |
string |
keywords |
Array<string> |
license |
string |
links |
Array<Link> |
providers |
Array<Provider> |
stapi_type |
string |
stapi_version |
string |
title |
string |
type |
string |
ProductsCollection¶
| Name | Type |
|---|---|
links |
Array<Link> |
products |
Array<Product> |
Provider¶
| Name | Type |
|---|---|
description |
string |
name |
string |
roles |
Array<ProviderRole> |
url |
string(uri) |
ProviderRole¶
Type: string
RequestMethod¶
Type: string
RootResponse¶
| Name | Type |
|---|---|
conformsTo |
Array<string> |
description |
string |
id |
string |
links |
Array<Link> |
title |
string |
ValidationError¶
| Name | Type |
|---|---|
loc |
Array<> |
msg |
string |
type |
string |
Tags¶
| Name | Description |
|---|---|
| Core | Core endpoints |
| Orders | Endpoint for creating and managing orders |
| Opportunities | Endpoint for viewing and accepting opportunities |
| Products | Products |