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/47e8e9df-5349-4b7c-97df-7fc10d22e271/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/47e8e9df-5349-4b7c-97df-7fc10d22e271/results/455392/?format=api",
            "id": 455392,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/455392/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/47e8e9df-5349-4b7c-97df-7fc10d22e271/results/455409/?format=api",
            "id": 455409,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/c9622127-2694-48d4-9f2f-18029446e0d8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/47e8e9df-5349-4b7c-97df-7fc10d22e271/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T063017Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d3d8020ea1cef88807d20f6aeee976cb9da3e27bf33aa36616938f3bbb9fbb07"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/47e8e9df-5349-4b7c-97df-7fc10d22e271/results/455410/?format=api",
            "id": 455410,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/bf81c4b5-e87a-4f80-928e-b1533a2eb6e1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/47e8e9df-5349-4b7c-97df-7fc10d22e271/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T063017Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=dece4fc05a39a762fd6a7aa295e5a2014fbfd9f2e13e1e0f972518196019cea4"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/47e8e9df-5349-4b7c-97df-7fc10d22e271/results/455411/?format=api",
            "id": 455411,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/43381250-4390-4c76-a7ac-03e13290626a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/47e8e9df-5349-4b7c-97df-7fc10d22e271/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T063017Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=99ebd7c3501cb88f027e11b0d932a1e2b41d2922d56928c6b4618b57eb03f778"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/47e8e9df-5349-4b7c-97df-7fc10d22e271/results/455412/?format=api",
            "id": 455412,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/6b64bcc9-ddf0-4bf1-89df-482c45cd436a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/47e8e9df-5349-4b7c-97df-7fc10d22e271/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T063017Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=11625999e565a4309af0b6ae940e618b22852cf45a14b64d556c6806a209faca"
        }
    ]
}