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/3cd9267f-a58a-4c6e-8875-9dabf36841f1/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/3cd9267f-a58a-4c6e-8875-9dabf36841f1/results/447953/?format=api",
            "id": 447953,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/447953/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/results/447954/?format=api",
            "id": 447954,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/a95b55be-cec5-4c84-9b43-32c69c2c0ad3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010507Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6112bd6249c638bc7e0335aaa4666f2af2e1ae8b09978052a6487d1b63ffe72f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/results/447955/?format=api",
            "id": 447955,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/80c01531-4899-46e7-acd0-c56cfb8685df/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010507Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1100dd8333baa317c41841d3314237f70b32142b61fd1605714614725826a247"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/results/447956/?format=api",
            "id": 447956,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/8b05e1aa-815d-4517-9fa6-c31eac23a89b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010507Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=182842c3bf21b353c7dd0d91bcf875befd29d35307ce9e3965b787c2a2357749"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/results/447957/?format=api",
            "id": 447957,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/e02699bf-4499-44a2-ada7-2244f096a65a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/3cd9267f-a58a-4c6e-8875-9dabf36841f1/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010507Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=36f16d921e4f966c5e61b7c39c02687f6e060f414a5a2cbd8cb96c77400a907f"
        }
    ]
}