Download the zip of a finished 3D extract

Streams <slug>_3d_<radius>m.zip (OBJ + MTL, DXF, DWG when LibreDWG produced one, GeoPackage, buildings.json, preview.png, README.txt) with Content-Disposition: attachment and Accept-Ranges: bytes (range requests are honoured, so a large zip can be resumed). 409 while the job is still queued/running (poll the status URL), 410 when it failed (the body carries the error), 404 for an unknown or evicted job.

Accepts the token in the token header or as ?token= - a download link must work from a plain <a href> and from a Grasshopper HTTP fetch, which cannot set headers. Treat such a URL as a credential.

GET

https://res.aireon.ch/res_api/building3d-extract/download/{jobId}

Authorization

ResApiToken
optional
API key in header

ResApiTokenQuery
optional
API key in query

Path parameters

jobId
string
required
Job id from the 202 of POST /res_api/building3d-extract (UUID v4).

format: uuid · pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

Query parameters

token
optional
string
The RES API token as a query parameter - alternative to the token header for links and header-less HTTP fetches (Grasshopper). Treat the resulting URL as a credential.

Returns

200

The zip bytes.

206

A byte range of the zip (when a Range header was sent).

400

jobId is not a UUID v4.

JSON

error
string
required
Human-readable error description.
message
optional
string
Optional underlying error message.

401

Authentication missing or invalid.

JSON

error
string
required
Human-readable error description.
message
optional
string
Optional underlying error message.

403

Authenticated but not permitted.

JSON

error
string
required
Human-readable error description.
message
optional
string
Optional underlying error message.

404

Resource not found.

JSON

error
string
required
Human-readable error description.
message
optional
string
Optional underlying error message.

409

The job is still queued or running - poll statusUrl and retry once status is ready.

JSON

error
string
required
status
queued
or
running
required
phase
optional
string | null
statusUrl
optional
string

410

The job failed (unknown address, no swissBUILDINGS3D 3.0 tile covering the point, empty box, worker crash) or its output has been evicted; error says why. Nothing will ever be downloadable for this jobId - start a new job.

JSON

error
string
required
status
error
required