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/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/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/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/results/441183/?format=api",
            "id": 441183,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/441183/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/results/441184/?format=api",
            "id": 441184,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/4b226e7e-77b7-45c2-ac2b-5bf1d849d6fd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T215122Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d3fbd50c3555e3a2664ab399dad23b638b5b29098f67a6955f30f726e8cf190c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/results/441185/?format=api",
            "id": 441185,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/647d7ebd-2f9b-4215-87da-b73a9d337070/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T215122Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c6c16488e236e2cc5ddab75c3b01fc67f24fd4e239069ce355a2763bf64e6d07"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/results/441186/?format=api",
            "id": 441186,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/ee036431-2f3d-4689-8038-8e6eb5e8b324/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T215122Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=59e250c1cdc763e6ad7b8ae15a76efe9bfeae99d517d395e7226d35c8ff7b30a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/results/441187/?format=api",
            "id": 441187,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/0ca4c65f-db1e-418e-8fff-53609d72d44b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce52f6b0-cdfe-4612-9edc-8c1f91e349d6/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T215122Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1fd7bb11d440d6736f3cd076dc85cb4f946cb6709b578cad50e7a94b24ccb575"
        }
    ]
}