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/a4058100-14b5-42f2-8836-f281d9dec06f/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/a4058100-14b5-42f2-8836-f281d9dec06f/results/455426/?format=api",
            "id": 455426,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/455426/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a4058100-14b5-42f2-8836-f281d9dec06f/results/455427/?format=api",
            "id": 455427,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/261a5f2c-f416-4685-ae4d-3cbcd5ec5000/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a4058100-14b5-42f2-8836-f281d9dec06f/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T063031Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=993a248e4139e8bd43816606ab7f828c0ae9e87a3d3b6439f26428647f030b22"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a4058100-14b5-42f2-8836-f281d9dec06f/results/455428/?format=api",
            "id": 455428,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/a2562226-7f02-4a4c-9046-4461fd47de32/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a4058100-14b5-42f2-8836-f281d9dec06f/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T063031Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c9129a24204b09a9a08a1090c3b0f6507562d5f6fb3068748923a58e08cb3bbb"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a4058100-14b5-42f2-8836-f281d9dec06f/results/455429/?format=api",
            "id": 455429,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/56464e0d-060f-432c-b7d0-ff5e9f196bd7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a4058100-14b5-42f2-8836-f281d9dec06f/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T063031Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2f40c1e850001a759af4742c0817a61b9a5bb980d71c1bfb7b5e03d43769c00b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a4058100-14b5-42f2-8836-f281d9dec06f/results/455430/?format=api",
            "id": 455430,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/f3067241-bbbe-4ac8-9d64-f6f226d47644/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a4058100-14b5-42f2-8836-f281d9dec06f/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T063031Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=81e358e1717278aeba117a7ae9167058b5c293c909870d59c059df989664952e"
        }
    ]
}