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/a6d130ab-f561-41d1-b2d8-c1681d770999/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/a6d130ab-f561-41d1-b2d8-c1681d770999/results/448251/?format=api",
            "id": 448251,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/448251/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a6d130ab-f561-41d1-b2d8-c1681d770999/results/448252/?format=api",
            "id": 448252,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/d788d728-49da-4a92-8ec6-e13fd7ebd6cd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a6d130ab-f561-41d1-b2d8-c1681d770999/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T223708Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c87d5ee5dabb6d3abd42dd76b830e31da76be0bc87ff729716a39795e2e14a34"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a6d130ab-f561-41d1-b2d8-c1681d770999/results/448253/?format=api",
            "id": 448253,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/f5a0f293-64ec-426a-b6f4-137bf0fb0fdb/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a6d130ab-f561-41d1-b2d8-c1681d770999/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T223708Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6d381db91bcd7bf0c1f257348db1a2b71601a3ad43351aa11e743866aab79582"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a6d130ab-f561-41d1-b2d8-c1681d770999/results/448254/?format=api",
            "id": 448254,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/7b54ed1e-a011-4478-a434-75432e1a54d7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a6d130ab-f561-41d1-b2d8-c1681d770999/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T223708Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e876bfcc95a200ea40e56a3906ae83eede30247cebb312763d99f96ac7ca04a5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a6d130ab-f561-41d1-b2d8-c1681d770999/results/448255/?format=api",
            "id": 448255,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/bba564ab-4217-4ca2-ad81-07f4117f845e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a6d130ab-f561-41d1-b2d8-c1681d770999/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T223708Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7077a7e014dc54a9c5e6660f012672062fde5acff7d9cc0edfd117276616cb47"
        }
    ]
}