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/b8009661-9f11-4d1b-ba94-a835888e5abf/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/b8009661-9f11-4d1b-ba94-a835888e5abf/results/455444/?format=api",
            "id": 455444,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/455444/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/results/455449/?format=api",
            "id": 455449,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/fe399e48-1760-4879-8c6f-6c6343ea79ea/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T120919Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3ada4b2dfa41e7eab51e9b8e942ec6846a970aac7f4c7084bf8a4b0f3afa3792"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/results/455450/?format=api",
            "id": 455450,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/53d1925b-7595-4d62-959d-c8e7e341ee39/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T120919Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=39e0bb41b02b658bd5558abc458a121bca85db78952008f18f66d9cfbdeecc5f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/results/455451/?format=api",
            "id": 455451,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/2c4117a6-5516-4374-8622-d79712d587b2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T120919Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e8e4289fe270b21a616ac7670678edb900631d089d84c8114479024db2f32e61"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/results/455452/?format=api",
            "id": 455452,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/b2aaecf0-0ea2-4334-888c-d7310535c92b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/b8009661-9f11-4d1b-ba94-a835888e5abf/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T120919Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a5f411bf2cd1d92377f7a5b3f3bf619b11c2b4fa2319f0d8d0971e6606385f3a"
        }
    ]
}