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/d303173d-9622-40f0-a1d2-fdc121f43aea/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/d303173d-9622-40f0-a1d2-fdc121f43aea/results/449641/?format=api",
            "id": 449641,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449641/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/results/449643/?format=api",
            "id": 449643,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/a94eca10-5d01-40dc-a6e8-50836d9e1073/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T112803Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fa71bd5ccccac2bd72ec1a0e1b69ab987da677df14e7be9ae0a6ad094c8e55f7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/results/449644/?format=api",
            "id": 449644,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/3de29f3e-d2b5-47c6-9484-5478a22a9340/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T112803Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e4b9f764e165eda0939cd504657f10491cdb1d9540411a89a6a9319297faa0f8"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/results/449645/?format=api",
            "id": 449645,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/159399b2-9813-44ce-8c81-b8dbc84f940f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T112803Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=be9d510f68db10a7e6102ce10d11767682c2136b72db65acc220374bb4820443"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/results/449646/?format=api",
            "id": 449646,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/677435b0-a639-4eed-9592-a4e893e6bd15/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d303173d-9622-40f0-a1d2-fdc121f43aea/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T112803Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3014e0407525b4c013ccbc65d6e755f8f171dd66a848d074161ad04759a4e75d"
        }
    ]
}