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/dc15e84c-00b0-4a4b-852f-5cedcf68db15/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/dc15e84c-00b0-4a4b-852f-5cedcf68db15/results/448873/?format=api",
            "id": 448873,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/448873/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/dc15e84c-00b0-4a4b-852f-5cedcf68db15/results/448878/?format=api",
            "id": 448878,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/c2883c64-4ec9-4597-998e-b1b099992e38/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/dc15e84c-00b0-4a4b-852f-5cedcf68db15/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T153610Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=eb0729d5076f1998b51e27a32415881c2f7d2853c0cc408ebaf09894449af085"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/dc15e84c-00b0-4a4b-852f-5cedcf68db15/results/448879/?format=api",
            "id": 448879,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/fff8ba05-8f68-4ed8-a4ac-88cbc691e91d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/dc15e84c-00b0-4a4b-852f-5cedcf68db15/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T153610Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=da52585bdd54fc759e9c8d0c1955365d23cf26a0134168c7afed561d390ff80d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/dc15e84c-00b0-4a4b-852f-5cedcf68db15/results/448880/?format=api",
            "id": 448880,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/7018ab48-9aea-4b99-9368-42a5b99a80e2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/dc15e84c-00b0-4a4b-852f-5cedcf68db15/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T153610Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9280fed913372ddc36a7b831e2a436487f6eee46cd4a42535f814c2af09ba7d1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/dc15e84c-00b0-4a4b-852f-5cedcf68db15/results/448881/?format=api",
            "id": 448881,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/33cba2b1-0c46-42f2-8467-f46e0390a006/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/dc15e84c-00b0-4a4b-852f-5cedcf68db15/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T153610Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=29d3532c51b5ae64e8f93b1f1f5c0b61423a5ac42caaf515716e1a791b9bb873"
        }
    ]
}