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/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/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/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/results/448902/?format=api",
            "id": 448902,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/448902/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/results/448911/?format=api",
            "id": 448911,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/8f6b5244-9e9a-4728-a9cc-f130c97b2cd5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T154618Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0737a4a77b38e6f0bb346080ae90237c3e042b18eb4895f87e7a4e25e65f50e3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/results/448912/?format=api",
            "id": 448912,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/f5993f27-5d51-4a68-bdae-bf64d25ad13e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T154618Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4a6507f3ef8f4bd9fe8416fd7990d3b6d113fce6050a5e3f0915e462d8461025"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/results/448913/?format=api",
            "id": 448913,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/cc6f8c2d-aff8-4102-a10e-9ba02235cbb9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T154618Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6799ecda1a14e73af7e2d3fe145555f22ba02fdd130cadaa6d57d10e454e7ee1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/results/448914/?format=api",
            "id": 448914,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/a530a046-f605-469f-90e8-c7d57b2c181a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ce47b3a7-e112-4ccf-a342-b483c7f1bb9d/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T154618Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=52d82a924cd32a77ea33e101f9b67375b735d6a978f4c5b08a93e96ff7edb5d9"
        }
    ]
}