resource-facade

Place an ELVIS Australian-elevation order over an AOI; the delivery auto-ingests into the project.

post/v1/catalog/elvis/order

Headers

x-api-keystring nullable

Request body

project_idstring required

Project the delivery ingests into (rides the reply-to address).

bboxnumber[] nullable

AOI [west, south, east, north] (WGS84).

intersectsobject nullable

AOI GeoJSON Polygon (alternative to bbox).

industrystring nullable

ELVIS 'industry' field (default 'Other').

out_coord_sysstring

Output CRS code for transformable datasets ("" = native).

out_formatstring

Output format code for transformable datasets ("" = native).

email_overridestring nullable

Override the delivery email. DEFAULT routes to elvis-job-<project_id>@inbound so the delivery auto-ingests — only override to send the link to a human instead.

productsstring[] nullable

Restrict the order to these ELVIS product types (case-insensitive), e.g. ["Point Clouds"] or ["Digital Elevation Models"]. DEFAULT orders everything available over the AOI — which can be ~40 tiles incl. whole-of-Australia DEM products. Use available_products from a prior call (or catalog.elvis.downloadables) to see options.

max_tilesinteger nullable

Cap the total number of tiles ordered (size/cost/turnaround control). Default: no cap. Combine with products to order, say, just the nearest point-cloud tile.

file_namesstring[] nullable

Order EXACTLY these tiles by ELVIS file_name (the per-tile selection from the portal's 'Add to My Data' tray — each ELVIS search result's id IS its file_name). The tiles are still re-sourced from live availability over the AOI so their fields are ELVIS-valid; only file_names that exist over the AOI are ordered. None = order all available (subject to products/max_tiles).

Response

Successful Response

request_idstring required
delivery_emailstring required
polygonstring required
dataset_blocksinteger required
tile_countinteger required
products_orderedstring[] required
available_productsobject required
auto_ingestboolean required
statusstring

Changes

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