Skip to main content

Tasking requests

Understand how a tasking request moves from creation through fulfillment, and how it maps to the Order API.

Terminology​

This documentation uses tasking request as the primary product term. In the HTTP API, that resource is named Order, with paths under /order/... (for example CreateOrder, GetOrders, GetOrderDetails).

What a tasking request represents​

A tasking request asks EarthLife to acquire new imagery over a defined point of interest (POI) or area, for a capture window and catalog options (image type, resolution, provider, cloud cover, and related service inputs).

High-level lifecycle​

Authenticate → Resolve catalog options → Create request → Track status → Inspect details
  1. Authenticate: Obtain a Bearer token from Auth (earthlife.orders scope).
  2. Resolve catalog: Call image type and resolution lookups; combine with your account’s ServiceID and input keys.
  3. Create: POST /order/Order/CreateOrder with "serviceID": 3 (Tasking service), POI, and the other tasking inputs.
  4. Track: List with filters via POST /order/Order/GetOrders, or load one record with GET /order/Order/GetOrderDetails.
  5. Inspect: Use OrderStatusID / OrderStatusTitle and optional OrderItems for line-level location and capture parameters.

Create query parameters​

ParameterDescription
noteOptional note
refNoOptional external reference
paymentMethodPayment method for the request (use 1)

Statuses (high level)​

Exact status IDs and labels can vary by deployment. Treat OrderStatusTitle as the human-readable state from list/detail responses. Typical progression includes states such as pending / in progress through terminal success or failure. Always rely on the values returned by the API rather than hard-coding a private enum.

Response shape on create​

Successful creates return a wrapper:

{
  "IsSuccess": true,
  "Message": null,
  "ReturnedValue": {
    "OrderData": { "OrderID": 694, "OrderStatusTitle": "Pending" },
    "HasSubscription": true,
    "PaymentURL": ""
  }
}

Check IsSuccess even when HTTP status is 200. See Errors.

Next steps​