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/78d58488-6b84-496b-aee0-f302c21cd95b/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/78d58488-6b84-496b-aee0-f302c21cd95b/results/455969/?format=api",
            "id": 455969,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/455969/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/78d58488-6b84-496b-aee0-f302c21cd95b/results/455970/?format=api",
            "id": 455970,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/40e1472a-ad72-4b40-affc-5b6d6a575a9e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/78d58488-6b84-496b-aee0-f302c21cd95b/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T063026Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=95a6569bf608bba024975b0260182f56df33072cbfa7a438e8d3ee885c83ebdd"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/78d58488-6b84-496b-aee0-f302c21cd95b/results/455971/?format=api",
            "id": 455971,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/f9e22acd-4b34-4795-8a04-e8e47290ebda/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/78d58488-6b84-496b-aee0-f302c21cd95b/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T063026Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4981e7dbf219b3f83081d7745f2457d0691ccbf1cbec7c71fcc1937954dcf0f5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/78d58488-6b84-496b-aee0-f302c21cd95b/results/455972/?format=api",
            "id": 455972,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/fd4264d1-0e7b-48da-a4a6-e463d8a1f756/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/78d58488-6b84-496b-aee0-f302c21cd95b/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T063026Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=15d7b4d0ae5ececde8c242046c4dba05777050cda145083a2f19f76f329bcbb0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/78d58488-6b84-496b-aee0-f302c21cd95b/results/455973/?format=api",
            "id": 455973,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/2404f71e-3ac4-4176-8a04-dd7f8e90450a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/78d58488-6b84-496b-aee0-f302c21cd95b/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T063026Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9e9898b3d0c543dd290df8a5ce51239ceb7484bd4c4575b839acbbe138c7a389"
        }
    ]
}