Damage – Django REST framework

Endpoint for interacting with 3Di scenario results.

Add attachments to newly created results by uploading a file (using a PUT request) to the temporary upload_url of a result.

Subendpoints

The subendpoints below have been defined for convienience and may be used for viewing or deleting a specific class of results. They are also available via the "Extra Actions" button in the top-right corner when viewing a result list.

/api/v4/scenarios/{uuid}/results/arrival/
/api/v4/scenarios/{uuid}/results/basic/
/api/v4/scenarios/{uuid}/results/damage/
/api/v4/scenarios/{uuid}/results/raw/
/api/v4/scenarios/{uuid}/results/tiles/

For example, a DELETE request on /api/v4/scenarios/{uuid}/results/raw/ would schedule all raw results for deletion. This is more convenient than deleting results one by one via /api/v4/scenarios/{uuid}/results/{id}/.

GET /api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/damage/?format=api

HTTP 200 OK
Allow: GET, DELETE, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "count": 5,
    "next": null,
    "previous": null,
    "results": [
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440173/?format=api",
            "id": 440173,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/440173/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440182/?format=api",
            "id": 440182,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/01c728fd-5ab9-4f2b-a2e2-1fce042c0161/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T002539Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=72685b1c80b7c42904e20220a359616d85eba0bd359db84788531f1914adc6f7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440183/?format=api",
            "id": 440183,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/87b6f876-0e67-49cd-b4b3-590b533a6bd3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T002539Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5099fafc3956ea9b4474f5a8a2db67ea0372e5c408034eac1334b44451c2eb81"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440184/?format=api",
            "id": 440184,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/ddf0960e-bbad-4127-af48-0d809adc64f2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T002539Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=133a32838e5a0c67d4fd85eea38114ab8c319b1411293cb2970155cc1064f4d1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/results/440185/?format=api",
            "id": 440185,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/d5440e50-2237-47e8-832c-c2f239c6a956/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2574e5fa-bb31-404e-aafd-a3ff1ca29baf/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T002539Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6151aa508d984d0a59c877e16fadb21ac114776a10ec237667a4b8b018fc5ac2"
        }
    ]
}