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/db8ed832-20f6-4a9f-a0be-33fcb1692643/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/db8ed832-20f6-4a9f-a0be-33fcb1692643/results/448205/?format=api",
            "id": 448205,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/448205/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/db8ed832-20f6-4a9f-a0be-33fcb1692643/results/448206/?format=api",
            "id": 448206,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/4927535c-766a-415d-87d4-05a4803d5ec1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/db8ed832-20f6-4a9f-a0be-33fcb1692643/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T193724Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=eb3e1f25b91d631acf4fd4461c830fe76869f98a6bee48a5c86268d32e124850"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/db8ed832-20f6-4a9f-a0be-33fcb1692643/results/448207/?format=api",
            "id": 448207,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/1535fe2d-51aa-425f-ab9d-b7c7959d57e0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/db8ed832-20f6-4a9f-a0be-33fcb1692643/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T193724Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0063b94af0c0b4134d65ff2a5a9113a6a7491256d0d46c0b1fa9eb303642a1dd"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/db8ed832-20f6-4a9f-a0be-33fcb1692643/results/448208/?format=api",
            "id": 448208,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/dffd0df5-5b56-429d-994b-e4cc877cfc2f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/db8ed832-20f6-4a9f-a0be-33fcb1692643/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T193724Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0e147d053f546dcf6417168a333ea1dda442063e255326d6e9237cb3ef6352cf"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/db8ed832-20f6-4a9f-a0be-33fcb1692643/results/448209/?format=api",
            "id": 448209,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/8cb29264-dc17-46c2-85d3-d8396a77cdfa/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/db8ed832-20f6-4a9f-a0be-33fcb1692643/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T193724Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d4119f88e48ac301078765ee67369a59a3696ccb608f36d974fefa1b6dd2b770"
        }
    ]
}