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/958554f2-8f8b-451c-a642-b33481e6408a/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/958554f2-8f8b-451c-a642-b33481e6408a/results/439879/?format=api",
            "id": 439879,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/439879/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/958554f2-8f8b-451c-a642-b33481e6408a/results/439880/?format=api",
            "id": 439880,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/18426891-9787-4a6b-881f-2bf07ce3ed50/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/958554f2-8f8b-451c-a642-b33481e6408a/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T121608Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e5664620f7ec6a7b019ea9062061643116201203a38c46465e519ea7f554b3b4"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/958554f2-8f8b-451c-a642-b33481e6408a/results/439881/?format=api",
            "id": 439881,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/5bf254a5-208e-4d92-94e2-2442696da9f7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/958554f2-8f8b-451c-a642-b33481e6408a/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T121608Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=af171a85f36782801672816bd7f6ece75db3521ef40b515a9985da687aab35a1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/958554f2-8f8b-451c-a642-b33481e6408a/results/439882/?format=api",
            "id": 439882,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/f1c4129c-31d9-4c71-b756-269c358844fe/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/958554f2-8f8b-451c-a642-b33481e6408a/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T121608Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=dd9012f7793d3ab80138f71ba2d5281aa236a45fabc35ca132724a0c57590d2c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/958554f2-8f8b-451c-a642-b33481e6408a/results/439883/?format=api",
            "id": 439883,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/c9074856-a4e7-41c1-b830-b3ce00b587d7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/958554f2-8f8b-451c-a642-b33481e6408a/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T121608Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=42f5692fcba97b672790d878bb426f9661cabb85bb8918673eb72ebd0f17278f"
        }
    ]
}