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/778276a5-b7ee-48a3-b0b2-9c3517a5c562/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/778276a5-b7ee-48a3-b0b2-9c3517a5c562/results/441249/?format=api",
            "id": 441249,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/441249/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/results/441251/?format=api",
            "id": 441251,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/90a3a1f8-09e7-4b00-803f-1b755730e525/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T012911Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f16935578f44ec667d05bcd953cae9ccd6ae3497d94dae38841349da8692d710"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/results/441252/?format=api",
            "id": 441252,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/004e0fe1-5358-4254-8ee2-bf165301e4d3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T012911Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4f66523df16da4c068bf0275e6a588533f164168bef7214c0a41184672181dd3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/results/441253/?format=api",
            "id": 441253,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/32d088d5-f230-4a95-bf66-4b5d2ec9b81d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T012911Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=62b001519f19d7916088f29515a1a9db13de80ea39d7e932d8572fc76b80ed18"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/results/441254/?format=api",
            "id": 441254,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/fc5b78b1-fc4a-42bf-bdb8-2e6d99137531/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/778276a5-b7ee-48a3-b0b2-9c3517a5c562/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T012911Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9c01936e36c73e8fa504575230dddbb5e7ab51105ba0670285d42b5764c1c024"
        }
    ]
}