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/a99124a1-388c-4b2c-ae88-3a927ac7d7a1/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/a99124a1-388c-4b2c-ae88-3a927ac7d7a1/results/439896/?format=api",
            "id": 439896,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/439896/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a99124a1-388c-4b2c-ae88-3a927ac7d7a1/results/439897/?format=api",
            "id": 439897,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/18dafed5-812a-4ba8-8941-9a951dc68859/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a99124a1-388c-4b2c-ae88-3a927ac7d7a1/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120332Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f7e7172b5977e8a4c93f662cb2ecffe587a216ed2b371b35fc2e9fe5909a5ee5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a99124a1-388c-4b2c-ae88-3a927ac7d7a1/results/439898/?format=api",
            "id": 439898,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/893d26f7-c756-4073-bd6f-fc2dff2e84ef/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a99124a1-388c-4b2c-ae88-3a927ac7d7a1/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120332Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fbab0747b256ce2bd46cb3dd2b63855c9edff6ef961835278923a84c90a4af65"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a99124a1-388c-4b2c-ae88-3a927ac7d7a1/results/439899/?format=api",
            "id": 439899,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/91bb057d-faeb-4c41-aab6-777754b35b78/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a99124a1-388c-4b2c-ae88-3a927ac7d7a1/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120332Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=35ecb243b7f4ece08567e20fcdc881ec42aed2e2f01dc45546e692c74601b105"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a99124a1-388c-4b2c-ae88-3a927ac7d7a1/results/439900/?format=api",
            "id": 439900,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/953b1921-edf5-42d2-9a08-1ddf8f5a50f2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a99124a1-388c-4b2c-ae88-3a927ac7d7a1/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T120332Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7c72f210b781eb8485989000088d02aa1f263bebf31cb2e52236d746933ed694"
        }
    ]
}