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/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/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/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448035/?format=api",
            "id": 448035,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/448035/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448036/?format=api",
            "id": 448036,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/37eb2531-eb73-4f03-b45e-8c7479d42ec6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T013828Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=24ed911e7b51e219e90f5899fabfd7f6ad2f300258990c2342df3155151dd0d5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448037/?format=api",
            "id": 448037,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/fb1153b6-5725-4720-8a51-6044eed8e6df/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T013828Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c63126a1270a63e2610b26f2cc41aef89514018a32ebdeb964f3e8678397027c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448038/?format=api",
            "id": 448038,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/7e896fc5-dce6-4f0b-98e5-14286794d337/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T013828Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2373e6aab619546dc210147132c18871429d5f6ec92190f8e85685e8a7a17eab"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/results/448039/?format=api",
            "id": 448039,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/f6ce5c49-a36e-45cf-b1e9-69ee2c619f99/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2ca275d4-8377-4fbe-90b2-dccf2339cf7a/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T013828Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6a9f5dc080b261b5f093aa0ccf1f73823617aa33d69f78c8f69ed1a143a2ec44"
        }
    ]
}