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/c3a51a1e-7b02-42a7-9b29-53da24ca882a/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/c3a51a1e-7b02-42a7-9b29-53da24ca882a/results/449543/?format=api",
            "id": 449543,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449543/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c3a51a1e-7b02-42a7-9b29-53da24ca882a/results/449545/?format=api",
            "id": 449545,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/743135c8-251c-47f3-b344-32d7c4545766/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c3a51a1e-7b02-42a7-9b29-53da24ca882a/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T184426Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e6c9933de4531070386ddbe0e75dc0c3c30128cef9750428f4c9f94cc036d949"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c3a51a1e-7b02-42a7-9b29-53da24ca882a/results/449546/?format=api",
            "id": 449546,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/175b3d69-1cb7-4cfb-8636-409505554450/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c3a51a1e-7b02-42a7-9b29-53da24ca882a/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T184426Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=20f388859b77e0493d73fd0592aaf75ef5413897c9333dd80c402d4c00e4f0d6"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c3a51a1e-7b02-42a7-9b29-53da24ca882a/results/449547/?format=api",
            "id": 449547,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/5f8fb9a5-843f-4969-92c8-006f049574d8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c3a51a1e-7b02-42a7-9b29-53da24ca882a/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T184426Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=eaffbb2275aefc37cbeebdcb31fd34cc5c97387c8c26d8c86a4194cd4cbfdbca"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c3a51a1e-7b02-42a7-9b29-53da24ca882a/results/449548/?format=api",
            "id": 449548,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/6e6ce037-ee49-4400-a056-2e3ce13127c6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c3a51a1e-7b02-42a7-9b29-53da24ca882a/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T184426Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=773f6235c229425286128dcd250b6a1fa2c966a9818e0ff847adaf3a58ef138c"
        }
    ]
}