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/2bcdf88d-1426-414e-a8d3-242a476cc2ab/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/2bcdf88d-1426-414e-a8d3-242a476cc2ab/results/440851/?format=api",
            "id": 440851,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/440851/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/results/440864/?format=api",
            "id": 440864,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/70e439ad-712b-4ed4-8659-2d8050b460cc/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004052Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e48c474333ccab72d0e3b97185d8d1f253dcf798c3cea57ac11bf0a5c40d9b30"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/results/440865/?format=api",
            "id": 440865,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/2a735e4f-78a1-40db-8ae9-0e9f0f224a2a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004052Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=11478bb42417437c3d44623f2c91b87e2a16d29b37066d922e6932f839f7aeb3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/results/440866/?format=api",
            "id": 440866,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/5cc71505-0ff5-4435-8299-6913cf433ecc/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004052Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f8ad81c49aaf8a95794bc6e8e46187789632abd4fb6edfa2f0dd15d93914a7e0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/results/440867/?format=api",
            "id": 440867,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/254dd193-764f-4ea1-bbf7-37075835fbee/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/2bcdf88d-1426-414e-a8d3-242a476cc2ab/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T004052Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8dd90bb0661d16200237b17fe73270a9e4986998c93bbf77c8d8ec48e65d4c60"
        }
    ]
}