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/4f537e62-4489-4dc1-9d67-13eee1e0965a/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/4f537e62-4489-4dc1-9d67-13eee1e0965a/results/449623/?format=api",
            "id": 449623,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449623/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/results/449625/?format=api",
            "id": 449625,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/19768c54-e840-45b2-81f7-f74a3ed4de07/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T112408Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8bd3cfa797cca368be4340950bcf6c123778f7fd3421b7f1715c20d5064e247c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/results/449626/?format=api",
            "id": 449626,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/62e38b9c-50c1-4e72-8f4a-9a6197dbcb55/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T112408Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0130ea451e777c33efe712a112c446a081e14db056963288cd276560bf853698"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/results/449627/?format=api",
            "id": 449627,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/53e9ede7-9418-4a7d-b6f5-605c59efc2a9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T112408Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3d2b71a949f8de77d98eeba5f6acccb81db32139b2b44fd120523f5ad14e6dd7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/results/449628/?format=api",
            "id": 449628,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/234cd773-95f4-4109-8328-73e1a7b2f875/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/4f537e62-4489-4dc1-9d67-13eee1e0965a/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T112408Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6fd9ba848c479b79f3bf524f042d86a88c5ec4ba23368a5f0456fa58d10fa1db"
        }
    ]
}