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/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/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/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449725/?format=api",
            "id": 449725,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449725/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449726/?format=api",
            "id": 449726,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/8898d3e2-01fe-496e-8e39-e501f40eb8ee/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T102958Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1418ae6ca309c9212e2c08cabbd63cc002ced1f626ccd0dfc91aa81b0749d3fe"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449727/?format=api",
            "id": 449727,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/ddf2b0d3-4588-4dbb-b5b8-1a9e7fbbae12/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T102958Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=75e884cb1722e283acdd81bffd7a85c61903fa64bba20d79f4ee75a9725d7758"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449728/?format=api",
            "id": 449728,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/3c0ac654-c7a0-424a-8bf5-e03aff0d2a7d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T102958Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=efe65007f6247f861d652c2d741b92a782b2b314a255648c958f7521eb8feb99"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/results/449729/?format=api",
            "id": 449729,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/77a96940-c3e0-4715-800b-a6686e90a4b2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/03de98b8-2653-4c1c-8cc2-b8f11a9de3b4/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T102958Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=21bf5ebccf7f107ccc91845dd0c9b09e969e9a4854202acedeed945a00f7afe5"
        }
    ]
}