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/ae96e2bd-941f-4e0b-a6d1-d7e25aed9cd7/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/ae96e2bd-941f-4e0b-a6d1-d7e25aed9cd7/results/449710/?format=api",
            "id": 449710,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449710/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ae96e2bd-941f-4e0b-a6d1-d7e25aed9cd7/results/449712/?format=api",
            "id": 449712,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/c054cc88-d4ef-4331-a69d-9c770e211225/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ae96e2bd-941f-4e0b-a6d1-d7e25aed9cd7/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T133019Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=964a24b006a6be034d6d414e19de11de141f51434bd719a80d1cac5970e259d9"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ae96e2bd-941f-4e0b-a6d1-d7e25aed9cd7/results/449713/?format=api",
            "id": 449713,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/1a9354c4-3399-4c23-a689-27db3d1d52ad/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ae96e2bd-941f-4e0b-a6d1-d7e25aed9cd7/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T133019Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=919868e3ae1f9a4beea79cb47970ffc7bd280c5b8c78ef7b49b4766dca31b254"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ae96e2bd-941f-4e0b-a6d1-d7e25aed9cd7/results/449714/?format=api",
            "id": 449714,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/19e9527d-9daf-4104-8788-2c4d6b7d6642/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ae96e2bd-941f-4e0b-a6d1-d7e25aed9cd7/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T133019Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b2e938d68d7b05f74af18c1a242b8e0cc7fba20e80495518e599aeb7e1716918"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ae96e2bd-941f-4e0b-a6d1-d7e25aed9cd7/results/449715/?format=api",
            "id": 449715,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/ee0812f8-85d9-4374-81ec-75d48d50e920/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ae96e2bd-941f-4e0b-a6d1-d7e25aed9cd7/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T133019Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2a2840da92d5fd2a6a0574bbf87696c7f1fabb410c50588809edb2615ea6fe23"
        }
    ]
}