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/419906d5-8914-41c3-82c0-549ce531acb3/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/419906d5-8914-41c3-82c0-549ce531acb3/results/449077/?format=api",
            "id": 449077,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449077/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/419906d5-8914-41c3-82c0-549ce531acb3/results/449086/?format=api",
            "id": 449086,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/044ec4ac-596c-4685-8fc4-c69e103a17c2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/419906d5-8914-41c3-82c0-549ce531acb3/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T165222Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=32346a92d7611223125fa3e5ae352aac85e2224c74ef02bdeaab64796caff183"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/419906d5-8914-41c3-82c0-549ce531acb3/results/449087/?format=api",
            "id": 449087,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/4505f2eb-fc79-4463-a23c-8b3b48fb9a87/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/419906d5-8914-41c3-82c0-549ce531acb3/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T165222Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a101116705790963d635771b5649286ad2fdc086c711bed4ccfcfbbe840c8046"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/419906d5-8914-41c3-82c0-549ce531acb3/results/449088/?format=api",
            "id": 449088,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/5f481d4b-9920-44ff-a72e-eec70169e52c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/419906d5-8914-41c3-82c0-549ce531acb3/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T165222Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8e83354649b5d615afbf172c0283f77a463f35d2eabc233c7e668f0a8722037d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/419906d5-8914-41c3-82c0-549ce531acb3/results/449089/?format=api",
            "id": 449089,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/1fc2aaff-f61e-4dd5-81d6-e738c14abfc6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/419906d5-8914-41c3-82c0-549ce531acb3/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T165222Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=472ab9f8f8b23b8261fce6acb0d6914c3cc0eeaa8401fc52e55eda057b174fd1"
        }
    ]
}