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/b6dcf3e1-35d2-4d82-84da-32462081c98b/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/b6dcf3e1-35d2-4d82-84da-32462081c98b/results/449304/?format=api",
            "id": 449304,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449304/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b6dcf3e1-35d2-4d82-84da-32462081c98b/results/449306/?format=api",
            "id": 449306,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/ccdbd203-8998-4bf4-8fbd-c76b997e928c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b6dcf3e1-35d2-4d82-84da-32462081c98b/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T163136Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8277f71f118922db3330700e7b5eb062ead427c3011b2cd1aa3109c54ad69151"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b6dcf3e1-35d2-4d82-84da-32462081c98b/results/449307/?format=api",
            "id": 449307,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/80164f7a-bd6f-4376-b6a1-aba0f1850d01/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b6dcf3e1-35d2-4d82-84da-32462081c98b/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T163136Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3263484354d574b617cffbcc20e361af03d73bd35c8f300c525012f41c419408"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b6dcf3e1-35d2-4d82-84da-32462081c98b/results/449308/?format=api",
            "id": 449308,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/995a4599-3602-49fc-aaed-44f46fabf435/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b6dcf3e1-35d2-4d82-84da-32462081c98b/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T163136Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=62f1c1cdc6987e9ac63501b8c3f77854e39041ed82eb1eb4b223aefa2948ca3a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b6dcf3e1-35d2-4d82-84da-32462081c98b/results/449309/?format=api",
            "id": 449309,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/ff15983b-92d0-446a-adba-66dddb7cbcea/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b6dcf3e1-35d2-4d82-84da-32462081c98b/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T163136Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fb6bb230b0f29a59394e1dc540435914edf64e3587c168995ea172f9081ac8c6"
        }
    ]
}