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/54268466-e543-4f08-baac-9919270c99c5/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/54268466-e543-4f08-baac-9919270c99c5/results/448323/?format=api",
            "id": 448323,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/448323/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/54268466-e543-4f08-baac-9919270c99c5/results/448332/?format=api",
            "id": 448332,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/5be89620-5bd5-4930-a8df-862c9ff0a04a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/54268466-e543-4f08-baac-9919270c99c5/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T223810Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=03d7b52f78280efddcc924883787acdf6c82b54eab7fbc3a1b0d74a8ec5a7e24"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/54268466-e543-4f08-baac-9919270c99c5/results/448333/?format=api",
            "id": 448333,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/deb0d00a-11b6-4d4d-bcde-1efbfe97d8f9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/54268466-e543-4f08-baac-9919270c99c5/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T223810Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b5247a3bd38efbdc24749e7fa98c8738fb6d78a205056ad01bd805e26df6ac49"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/54268466-e543-4f08-baac-9919270c99c5/results/448334/?format=api",
            "id": 448334,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/bf86a623-2079-42b3-92c8-bf7df2f53965/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/54268466-e543-4f08-baac-9919270c99c5/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T223810Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fdc3522ad3f6bba48593e073c12970cef2aeee509138342f06242d367d0bff7c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/54268466-e543-4f08-baac-9919270c99c5/results/448335/?format=api",
            "id": 448335,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/d13635c9-1f2f-4829-8d78-7730dcdef8d9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/54268466-e543-4f08-baac-9919270c99c5/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T223810Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=cc702667934d02bf205d149c02dc3218f5cb0a7e867570d8b216745af83e9a82"
        }
    ]
}