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/5428029e-d250-4e2a-889a-ddc4dec38e39/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/5428029e-d250-4e2a-889a-ddc4dec38e39/results/440776/?format=api",
            "id": 440776,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/440776/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5428029e-d250-4e2a-889a-ddc4dec38e39/results/440785/?format=api",
            "id": 440785,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/dc13074f-a730-4f81-8992-6557ae2df1e9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5428029e-d250-4e2a-889a-ddc4dec38e39/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T085426Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=41676e8154d428ba8a4d302b492bfbd8917c1c5da42ae5699d35c1486044692d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5428029e-d250-4e2a-889a-ddc4dec38e39/results/440786/?format=api",
            "id": 440786,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/72cdeb01-f4b3-40bc-b1c3-07b307c5b480/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5428029e-d250-4e2a-889a-ddc4dec38e39/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T085426Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0fe2b4f0ba2894bf270c0647142ff955bb50438b7a5ad51bc7d2a8fb20905c72"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5428029e-d250-4e2a-889a-ddc4dec38e39/results/440787/?format=api",
            "id": 440787,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/bd58676b-c620-468d-8d65-bdb2c9691951/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5428029e-d250-4e2a-889a-ddc4dec38e39/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T085426Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0802ae27ceec976c57c7e828a304c4ebd18ebc190e84b1b4f44e7a178afaf676"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/5428029e-d250-4e2a-889a-ddc4dec38e39/results/440788/?format=api",
            "id": 440788,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/a1929fe4-e5bb-4a0f-a967-f1de2f2bb8c4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/5428029e-d250-4e2a-889a-ddc4dec38e39/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T085426Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=727a4eeced7e70af1aa8911d5a7c866687a79cb60571278616af4b6ec00de95c"
        }
    ]
}