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/68b823da-f5ab-454b-8314-597b02caf6e4/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/68b823da-f5ab-454b-8314-597b02caf6e4/results/449703/?format=api",
            "id": 449703,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449703/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/results/449704/?format=api",
            "id": 449704,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/db11bfe9-3251-493f-ae1b-213d86c4ac91/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T112915Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b63b8c1641576409c147344cbbec280c7c195e922e357dcf57875cbf729cefa0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/results/449705/?format=api",
            "id": 449705,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/512d0f73-60eb-4184-bfee-2794492c8804/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T112915Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ca99bfb466527584e227d73d814aaef8d35c41733aa67919a25f4d32208ee4db"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/results/449706/?format=api",
            "id": 449706,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/5fbbffb7-0c3c-4c3e-b591-77aa34f681de/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T112915Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4a10a2da6ee7bcbb3bc735b737be968c2d6af099d84bfe50911964a50e425533"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/results/449707/?format=api",
            "id": 449707,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/d4b66cd8-bf18-48c4-88ec-2bae28673339/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/68b823da-f5ab-454b-8314-597b02caf6e4/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T112915Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=33a76447f82d5a96057c3881aefbf7163e20e8e5c7400343edc39dba2c5634b7"
        }
    ]
}