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/c2c68ff5-f6eb-4766-ad90-709f7020f9c4/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/c2c68ff5-f6eb-4766-ad90-709f7020f9c4/results/448993/?format=api",
            "id": 448993,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/448993/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c2c68ff5-f6eb-4766-ad90-709f7020f9c4/results/448998/?format=api",
            "id": 448998,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/fd00f10d-5d85-46cb-a41a-e12e29b10e77/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c2c68ff5-f6eb-4766-ad90-709f7020f9c4/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T134006Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=424f2c1d3db1026a8f8945b50d03b03289b430967e037421abfe3a7edcb3061a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c2c68ff5-f6eb-4766-ad90-709f7020f9c4/results/448999/?format=api",
            "id": 448999,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/b4042d28-fb75-4fdc-b063-61c84402de3c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c2c68ff5-f6eb-4766-ad90-709f7020f9c4/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T134006Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=aabe100c6d6f1b38ca739bbf9e0943fd0c0d306046753bbafa7726acaedd70f4"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c2c68ff5-f6eb-4766-ad90-709f7020f9c4/results/449000/?format=api",
            "id": 449000,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/1e896f68-97c2-474f-9944-54be8c8675ce/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c2c68ff5-f6eb-4766-ad90-709f7020f9c4/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T134006Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=adf9b88616df935eefcc5ccbff0b4ddd6ed91293d277c9dc6ab5effa234db44f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c2c68ff5-f6eb-4766-ad90-709f7020f9c4/results/449001/?format=api",
            "id": 449001,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/c17c6fad-9a69-46a1-9d01-695205ff4bdf/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c2c68ff5-f6eb-4766-ad90-709f7020f9c4/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T134006Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=eb80b0305e56f3062a50174b780057bd058f689812d0da1dbfe6fd9e62ef4b2f"
        }
    ]
}