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/459dc4ed-287a-4d3e-adbe-cd15992d7075/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/459dc4ed-287a-4d3e-adbe-cd15992d7075/results/441649/?format=api",
            "id": 441649,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/441649/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/459dc4ed-287a-4d3e-adbe-cd15992d7075/results/441650/?format=api",
            "id": 441650,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/c693ed7a-e069-4b69-8aac-7e746e614864/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/459dc4ed-287a-4d3e-adbe-cd15992d7075/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T014956Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9c368589fc414b2396d90090e586dafbdfd2386aa6d11dba4f383c6dc20e2620"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/459dc4ed-287a-4d3e-adbe-cd15992d7075/results/441651/?format=api",
            "id": 441651,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/3e9bec59-2133-4b34-bca3-a47d7c3f4284/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/459dc4ed-287a-4d3e-adbe-cd15992d7075/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T014956Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=986ed2417ae9c71161c3fa3f4b94febf8f320b9ec2ee0f694a386eff377e21f7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/459dc4ed-287a-4d3e-adbe-cd15992d7075/results/441652/?format=api",
            "id": 441652,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/569d3d3c-7f45-4559-87ca-7bd866b12152/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/459dc4ed-287a-4d3e-adbe-cd15992d7075/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T014956Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b21a3fcd0a270bb1aaee50369ce46cd222aff0fa019609ca7c056b7faeb90d88"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/459dc4ed-287a-4d3e-adbe-cd15992d7075/results/441653/?format=api",
            "id": 441653,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/eed8de35-6876-477f-9e1e-7c5073a119af/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/459dc4ed-287a-4d3e-adbe-cd15992d7075/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T014956Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7c2c9af0418691eb58b59b043dd4f1aaf1bc8822a73960e1dcdadc867ebb78f8"
        }
    ]
}