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/334c23ae-0f74-4176-b2bd-e5a75a224b62/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/334c23ae-0f74-4176-b2bd-e5a75a224b62/results/441224/?format=api",
            "id": 441224,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/441224/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/results/441225/?format=api",
            "id": 441225,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/330f6cfc-6445-4ded-88fb-a5ee00e0c8ed/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T051108Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=71c198bac8cc049ef42e546d63558b5f8d9189a40a9c77278cf84837233ea2c1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/results/441226/?format=api",
            "id": 441226,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/ba25eb1a-9f5f-4b1b-b79b-113ee2e4f463/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T051108Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3c579fe42614549b465a9436612b9c0f42b9ca8cf087646741042dcbdba29694"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/results/441227/?format=api",
            "id": 441227,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/ccf3f589-b963-4a79-9d49-d41ed1a349cd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T051108Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=38d28492b7af168b6983bebfae5674be8434410017fb340bc35ad552ddb8658a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/results/441228/?format=api",
            "id": 441228,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/a87bd44d-d16a-4de9-ac6a-2755d62390b7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/334c23ae-0f74-4176-b2bd-e5a75a224b62/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T051108Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d0b141c0892517a3bc7643b42503154aa1e379b7ed88905674d5a64f4a5f94fe"
        }
    ]
}