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/92cb60f0-2b27-4c4f-95b0-8f000cce7437/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/92cb60f0-2b27-4c4f-95b0-8f000cce7437/results/441199/?format=api",
            "id": 441199,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/441199/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/92cb60f0-2b27-4c4f-95b0-8f000cce7437/results/441208/?format=api",
            "id": 441208,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/db6412df-9e9c-452e-beb0-5e6942943146/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/92cb60f0-2b27-4c4f-95b0-8f000cce7437/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T051822Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=58f08751ab01aff8c77e8868e782daf34327fb148f2866005a97a22e1f0a0776"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/92cb60f0-2b27-4c4f-95b0-8f000cce7437/results/441209/?format=api",
            "id": 441209,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/0834fa61-0ca8-4e89-804e-b2993bc741b4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/92cb60f0-2b27-4c4f-95b0-8f000cce7437/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T051822Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=593aeb24b6fcd2f6894b2351633dde27a33049ff6aef9cc0671e2d7c38878f87"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/92cb60f0-2b27-4c4f-95b0-8f000cce7437/results/441210/?format=api",
            "id": 441210,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/88a1765b-f940-4a2c-9e3f-a1e16bd6c757/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/92cb60f0-2b27-4c4f-95b0-8f000cce7437/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T051822Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a22838a9105b7ca85b19bf7c1fb6bb503975f30b32dcbaa84f4019873f1515cb"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/92cb60f0-2b27-4c4f-95b0-8f000cce7437/results/441211/?format=api",
            "id": 441211,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/ea911555-bac5-4726-ae5a-1b1746982372/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/92cb60f0-2b27-4c4f-95b0-8f000cce7437/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T051822Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f6099bf33689c0c97b65346f37738f143a142cb9548c03d6c2d4c6688440e683"
        }
    ]
}