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/9aa6fe72-f10a-4d31-88b4-4129a877644e/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/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/447998/?format=api",
            "id": 447998,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/447998/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/448019/?format=api",
            "id": 448019,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/12fdc202-a3ad-43cb-b707-e34c429604dd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T015103Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2b75349138d373092dcd415e20066d12934565f2950137804f584914a3caa5b1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/448020/?format=api",
            "id": 448020,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/9889056a-621a-4263-9452-7b51932e282f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T015103Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c49f27c6aec7afd6a08ef2f5143e06bcabc5d6e1f7f7086abde5952f15a99988"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/448021/?format=api",
            "id": 448021,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/04952cf9-8a2e-40ea-94df-69a9b8ff6547/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T015103Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=082339c05227fbc0b6c81012b3e5b6c9f78e0e5b9a0dcb116624b3b3db96fbed"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/results/448022/?format=api",
            "id": 448022,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/5f90d1eb-b450-4f1f-a91a-71bf6daf55f6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/9aa6fe72-f10a-4d31-88b4-4129a877644e/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T015103Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2d36234714544c2c8ba06e147891ff19a931ebdfa2b6b4ad9d8387435100be6b"
        }
    ]
}