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/8c753345-b2c5-44fb-ab4f-715780371c9e/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/8c753345-b2c5-44fb-ab4f-715780371c9e/results/448222/?format=api",
            "id": 448222,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/448222/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/8c753345-b2c5-44fb-ab4f-715780371c9e/results/448227/?format=api",
            "id": 448227,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/b4d00d34-d663-4d16-ab75-977716406132/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/8c753345-b2c5-44fb-ab4f-715780371c9e/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192309Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e4b259b52b1ef21686e448b69a042027d56e11f5a42d5df2053de6a289579977"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/8c753345-b2c5-44fb-ab4f-715780371c9e/results/448228/?format=api",
            "id": 448228,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/260f24cd-3195-46f1-aac8-f48891b2d154/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/8c753345-b2c5-44fb-ab4f-715780371c9e/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192309Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5f3b2cea9a25a8a8dba2565a55a40c9e95a6e447e5756319b4b6977db48153f8"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/8c753345-b2c5-44fb-ab4f-715780371c9e/results/448229/?format=api",
            "id": 448229,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/c0a1141b-d417-461e-893a-c570d70ec55a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/8c753345-b2c5-44fb-ab4f-715780371c9e/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192309Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2407cbd09e8e404ba9fc960fc4f30b2fd54b284eed4c8157d40c00743be65cf6"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/8c753345-b2c5-44fb-ab4f-715780371c9e/results/448230/?format=api",
            "id": 448230,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/62205c65-1173-4c5f-8a27-2cf0ae1d0d73/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/8c753345-b2c5-44fb-ab4f-715780371c9e/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192309Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=05752535fd8e07d8b4f35b87b60d6bf9be5f03e35ec3cdffddc0e26e1537fee0"
        }
    ]
}