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/15681485-fd3d-4af9-a7ea-20dab0093311/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/15681485-fd3d-4af9-a7ea-20dab0093311/results/441063/?format=api",
            "id": 441063,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/441063/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/15681485-fd3d-4af9-a7ea-20dab0093311/results/441064/?format=api",
            "id": 441064,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/7b7c275b-050f-4eb8-aec2-3dfae64c2f71/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/15681485-fd3d-4af9-a7ea-20dab0093311/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T084102Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6170aa982abe20153d2f73f80eae96bb93b21b6f023f78801693c79579342417"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/15681485-fd3d-4af9-a7ea-20dab0093311/results/441065/?format=api",
            "id": 441065,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/3319dd26-c37d-4601-957d-ff5f100e77a1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/15681485-fd3d-4af9-a7ea-20dab0093311/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T084102Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4180df65aee9c14291b9145c69bb4a3e273abca3b755b6455a49a1485cf80258"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/15681485-fd3d-4af9-a7ea-20dab0093311/results/441066/?format=api",
            "id": 441066,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/53170c9a-41e8-4041-a99b-4451c3d1eb5e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/15681485-fd3d-4af9-a7ea-20dab0093311/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T084102Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2ec4661664f07077a48178361204636da2cb991dd70af6652706dac70e326e39"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/15681485-fd3d-4af9-a7ea-20dab0093311/results/441067/?format=api",
            "id": 441067,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/37400186-ac2c-4491-9a69-9e27a4de289b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/15681485-fd3d-4af9-a7ea-20dab0093311/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T084102Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6873bd60be23dcf16db96364c6889c9944d16d3ef1f704ebe670139418987e9a"
        }
    ]
}