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/aa58854a-6486-403b-a000-5ba185a52625/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/aa58854a-6486-403b-a000-5ba185a52625/results/452308/?format=api",
            "id": 452308,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452308/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aa58854a-6486-403b-a000-5ba185a52625/results/452319/?format=api",
            "id": 452319,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/868eafe8-1e1f-45ac-9890-cdb93265c503/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aa58854a-6486-403b-a000-5ba185a52625/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T114642Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b8f14083fe5c3c18ed5c9fc61f7a3a4efe5521f15b7df5a67f0b9cb724cfa787"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aa58854a-6486-403b-a000-5ba185a52625/results/452320/?format=api",
            "id": 452320,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/ddfccb1d-c9c2-4171-aa06-f0b375cfadd6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aa58854a-6486-403b-a000-5ba185a52625/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T114642Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fb30378a888fd05147243926d562b3c4b1b6799a31c31970a6d7b831e949deb2"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aa58854a-6486-403b-a000-5ba185a52625/results/452321/?format=api",
            "id": 452321,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/b7b95aa2-e5cc-4ab6-8ab0-83f3eb66cb3c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aa58854a-6486-403b-a000-5ba185a52625/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T114642Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5127860bdad513a94ca1954494f883c3e48b65de32b207cf81b4a1b78f968047"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/aa58854a-6486-403b-a000-5ba185a52625/results/452322/?format=api",
            "id": 452322,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/691bd36f-1ede-473a-a706-7e19bd044828/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/aa58854a-6486-403b-a000-5ba185a52625/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T114642Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5566618d69ac286ef99c23705e9da6cf36537a66969ac32bb733c9b139a4f272"
        }
    ]
}