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/f168d19b-06d6-4ab2-bb63-8e82050fef8d/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/f168d19b-06d6-4ab2-bb63-8e82050fef8d/results/441299/?format=api",
            "id": 441299,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/441299/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f168d19b-06d6-4ab2-bb63-8e82050fef8d/results/441301/?format=api",
            "id": 441301,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/320c9107-14f2-46fc-bcde-53173bc0ae73/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f168d19b-06d6-4ab2-bb63-8e82050fef8d/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011445Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1f76374d3f26f7f49d389ad685df9daa23d0590e0a6b706548ef85e73b599dde"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f168d19b-06d6-4ab2-bb63-8e82050fef8d/results/441302/?format=api",
            "id": 441302,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/41a759f5-0b2d-4ddf-b9a8-e8ead1a8b940/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f168d19b-06d6-4ab2-bb63-8e82050fef8d/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011445Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b320a3e8e8660b74a0edbd90e81efc739a2beca05597031476ece2f32840209c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f168d19b-06d6-4ab2-bb63-8e82050fef8d/results/441303/?format=api",
            "id": 441303,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/d5daf6a3-c34a-4574-a043-98982552286e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f168d19b-06d6-4ab2-bb63-8e82050fef8d/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011445Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=88824a10817bdbb8c15e283e93bd77f887b9bbffcd092f7fed518b24bafab5dd"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f168d19b-06d6-4ab2-bb63-8e82050fef8d/results/441304/?format=api",
            "id": 441304,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/c4d8d57b-31dc-4380-aaaf-42e765ffd90d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f168d19b-06d6-4ab2-bb63-8e82050fef8d/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011445Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=45c9af3ebcf0b73b5ac23691c1488b1fcd69286e2abaf0742865d1547931cf9c"
        }
    ]
}