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/55331a65-c744-4d7c-8fca-4ebc29704523/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/55331a65-c744-4d7c-8fca-4ebc29704523/results/452366/?format=api",
            "id": 452366,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452366/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/results/452375/?format=api",
            "id": 452375,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/70f8b0e3-78ef-498b-8f65-30972d2ac7c8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T083858Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=26775530e0931a665b09a0820796a14060ac4c3a4caa680ea18b30c13416ac93"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/results/452376/?format=api",
            "id": 452376,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/ec201ea2-e9f5-4388-bfaa-02279b2130a6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T083858Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=67ecd5ac60a63ef9bc641d6098269d47b1a9e1d0e37f3302f8d4b95b62775fb4"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/results/452377/?format=api",
            "id": 452377,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/81933a3f-05cd-4435-808c-ed3b860085d4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T083858Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2d801540603d637c3c93e644b0d6d98064312a7d20c67967e04bd9eeb7e6d998"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/results/452378/?format=api",
            "id": 452378,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/671057e5-890c-4099-830e-fcfefc92b4fb/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/55331a65-c744-4d7c-8fca-4ebc29704523/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T083858Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e8cc09645d3c22c27c5270f9cab01e423a7486b6b8b58218052e8ee57216034a"
        }
    ]
}