This document explains the structure of a STAT Order request which is used for placing orders.
Ordering with loosely defined order values will give the provider more freedom to schedule. Define the values strictly to increase the chance of the preferred capture moment.
Endpoint: GET /order, POST /order
| Field Name | Type | Description |
|---|---|---|
| datetime | string | REQUIRED. Datetime field is a ISO8601 Time Interval |
| product_id | string | REQUIRED. Product identifier. The ID should be unique and is a reference to the constraints which can be used in the constraints field. |
| geometry | GeoJSON Geometry Object | REQUIRED. Defines the full footprint of the asset represented by this item, formatted according to RFC 7946, section 3.1. The footprint should be the default GeoJSON geometry, though additional geometries can be included. Coordinates are specified in Longitude/Latitude or Longitude/Latitude/Elevation based on WGS 84. |
| constraints | Map<string, [*]|Range Object|JSON Schema Object> | STRONGLY RECOMMENDED. A map of opportunity constraints, either a set of values, a range of values or a JSON Schema. |
| Field Name | Type | Description |
|---|---|---|
| id | string | Unique provider generated order ID |
| user | string | User or organization ID ? |
| status | OrderStatus | Enumerated Status of the Order |
| created | datetime | When the order was created |
| updated | datetime | When the order was last updated |
| links | [string] | List of URIs or IDs of Items |