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/049a4784-9b33-4fe3-a6a0-236cc1dd281b/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/049a4784-9b33-4fe3-a6a0-236cc1dd281b/results/441565/?format=api",
            "id": 441565,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/441565/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/049a4784-9b33-4fe3-a6a0-236cc1dd281b/results/441570/?format=api",
            "id": 441570,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/1c361abf-2079-4968-9fbd-c3e0a1aa0faf/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/049a4784-9b33-4fe3-a6a0-236cc1dd281b/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T050018Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e17c2730b7e96b3956387b8023139149544c3fcf6ffdffc9635ee2c4b2601660"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/049a4784-9b33-4fe3-a6a0-236cc1dd281b/results/441571/?format=api",
            "id": 441571,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/e1ee5420-ddab-4cbc-9be4-ff3735e4369f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/049a4784-9b33-4fe3-a6a0-236cc1dd281b/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T050018Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=368ca3906384af60d61d8d216b0c818bbfeb96e1c91518cbfdecda7392c3da05"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/049a4784-9b33-4fe3-a6a0-236cc1dd281b/results/441572/?format=api",
            "id": 441572,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/1b397b68-d904-4b0f-8fca-7985e335d32f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/049a4784-9b33-4fe3-a6a0-236cc1dd281b/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T050018Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=18e009b50c050ee2e0d3d72ab66c7ac9b008ada2508be647d78bfa0bd685d9e1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/049a4784-9b33-4fe3-a6a0-236cc1dd281b/results/441573/?format=api",
            "id": 441573,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/f566d5e2-a31c-416b-b0ed-a8f4a494e87e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/049a4784-9b33-4fe3-a6a0-236cc1dd281b/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T050018Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=08f991f8b69adf07f12bf27dcb116416aa6614bedd9424820cbeaed440ae2f83"
        }
    ]
}