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/58ecbef9-50c5-4b63-94b2-a765ad935f5a/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/58ecbef9-50c5-4b63-94b2-a765ad935f5a/results/452340/?format=api",
            "id": 452340,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452340/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/results/452341/?format=api",
            "id": 452341,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/f15ad3a7-caec-4c4f-85b6-91698e8f257e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062328Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=db0b72950abdd6f59dc33bb2872b03b44d3a2d4d4a929faf6932711fd073e7a5"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/results/452342/?format=api",
            "id": 452342,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/5cc83b0d-371b-4e12-b338-afac57127cfc/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062328Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c50591c78f543c4b14fb3cfb3f832c0085d3f12c259d1286bcd54954364e30ed"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/results/452343/?format=api",
            "id": 452343,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/0c94c4c4-1241-4665-b9ed-29c3ea62e7af/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062328Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e6c535a85acdeaf41ff298bc611d42f60d5035cf5413097e834ebf5e6f5a1225"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/results/452344/?format=api",
            "id": 452344,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/37d8eb44-4b80-44e8-8cd4-450878c38a0b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/58ecbef9-50c5-4b63-94b2-a765ad935f5a/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062328Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d0110f0ac5233294305e1760a1beed3bf85fd7197e8f38300821fd27c4296cc7"
        }
    ]
}