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/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/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/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/results/453488/?format=api",
            "id": 453488,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/453488/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/results/453498/?format=api",
            "id": 453498,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/05984f11-561e-4139-9377-76cc7323a9e8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T071637Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9dfb736127bf5be05376452b5699881290126ed55f3d8b9f0587a1dcbd905982"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/results/453499/?format=api",
            "id": 453499,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/3d4cdbea-d1a1-4063-8f7a-d8641fa37790/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T071637Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=32b9657b005b48e67b3357b97042aae142e9537f7e3b51e8d9954de3eaab2715"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/results/453500/?format=api",
            "id": 453500,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/5b45f04e-8963-46df-b79d-2a4902cf9e71/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T071637Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=28f78424d01dfc2b3b749f33ac8ae17f18a5a6108641ed79b38e726c5661b5fd"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/results/453501/?format=api",
            "id": 453501,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/8038dd41-9368-41d2-9336-8a4644be1b1a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a50f1fb5-a8b1-42c8-b3d3-e22eec302791/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T071637Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9b746afe33d575e6b8910a9af0e0d6fbca8b3c0ea3bb48a7c5d7d7fe995d1650"
        }
    ]
}