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/083da304-0459-4dc3-9d89-806d98da4d38/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/083da304-0459-4dc3-9d89-806d98da4d38/results/441036/?format=api",
            "id": 441036,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/441036/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/083da304-0459-4dc3-9d89-806d98da4d38/results/441038/?format=api",
            "id": 441038,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/2f20b2c7-3c63-450b-be05-10696ed6e65b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/083da304-0459-4dc3-9d89-806d98da4d38/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T084245Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=058ff9467469731fe47d66f92963338b047043f7f0d9dac09a6c9ebcbc676b1a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/083da304-0459-4dc3-9d89-806d98da4d38/results/441039/?format=api",
            "id": 441039,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/8ce84ec8-035b-4071-8f40-c02ed21ba58b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/083da304-0459-4dc3-9d89-806d98da4d38/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T084245Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=cf28fc5403d4979f256f15ef34ec0135ab623fa5ec5f3f8dcfeb2e431dfef173"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/083da304-0459-4dc3-9d89-806d98da4d38/results/441040/?format=api",
            "id": 441040,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/40db8e2e-992d-4926-8751-028a3f377b4a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/083da304-0459-4dc3-9d89-806d98da4d38/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T084245Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8b0a927ef573f6fba86fba0cc59fa6dfe95166a10e1900e54f1158165539d0e5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/083da304-0459-4dc3-9d89-806d98da4d38/results/441041/?format=api",
            "id": 441041,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/b2eb9a62-a3ef-43f5-b48f-3fbdda547a5e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/083da304-0459-4dc3-9d89-806d98da4d38/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T084245Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3ad6e3a31e543bf227ac92c2efce8a8484f6dbfa46a424a42ef2702d0083e52a"
        }
    ]
}