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/1c54cb29-a4a4-4fa8-8acd-15bfcf68aa6b/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/1c54cb29-a4a4-4fa8-8acd-15bfcf68aa6b/results/448835/?format=api",
            "id": 448835,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/448835/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1c54cb29-a4a4-4fa8-8acd-15bfcf68aa6b/results/448841/?format=api",
            "id": 448841,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/55b6f39a-3b89-4e5f-8728-6998726e05e2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1c54cb29-a4a4-4fa8-8acd-15bfcf68aa6b/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T193054Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=455dfabf72fd92c34f2ae811921d0fb05431ad0923e7e565e63790fdece3ce09"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1c54cb29-a4a4-4fa8-8acd-15bfcf68aa6b/results/448842/?format=api",
            "id": 448842,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/4cd8e355-2344-4f0e-bdf1-3704c58d08c5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1c54cb29-a4a4-4fa8-8acd-15bfcf68aa6b/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T193054Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d774e1649a404ca9cf11b005ac85a8e4b0585e6bb05f5d16fbd6b999fc5f707e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1c54cb29-a4a4-4fa8-8acd-15bfcf68aa6b/results/448843/?format=api",
            "id": 448843,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/1df0eda0-25ca-4b6f-821c-88914a51061c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1c54cb29-a4a4-4fa8-8acd-15bfcf68aa6b/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T193054Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6b64b57933245f16a19e13871c4c4fbfa5fc1f5e7ab84da92da6774a7fe4e688"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1c54cb29-a4a4-4fa8-8acd-15bfcf68aa6b/results/448844/?format=api",
            "id": 448844,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/e05c4b3b-3215-44c1-9a9d-2fa327d30090/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1c54cb29-a4a4-4fa8-8acd-15bfcf68aa6b/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T193054Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d589919a49000c70170cb9187fa04ab396de49a52024a446f3620694713e9a24"
        }
    ]
}