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/078a981f-c816-4c6c-a584-2c94f6831164/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/078a981f-c816-4c6c-a584-2c94f6831164/results/441267/?format=api",
            "id": 441267,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/441267/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/078a981f-c816-4c6c-a584-2c94f6831164/results/441284/?format=api",
            "id": 441284,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/971fc6ee-9bb6-4bf9-8686-f7e62f9e1c98/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/078a981f-c816-4c6c-a584-2c94f6831164/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010722Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d338baee6757446a48709e1ad32668a13bbed7d9946c4b349a5035b6c743df94"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/078a981f-c816-4c6c-a584-2c94f6831164/results/441285/?format=api",
            "id": 441285,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/c8ffb966-405a-40fa-ba71-48802ffe7ddd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/078a981f-c816-4c6c-a584-2c94f6831164/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010722Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3c8908441fd1491c8eda5c2a8355599849319fa8a440d4c504d4c2253cf82298"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/078a981f-c816-4c6c-a584-2c94f6831164/results/441286/?format=api",
            "id": 441286,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/bfb33605-6f1d-4cc8-886e-2fc8f4ca8404/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/078a981f-c816-4c6c-a584-2c94f6831164/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010722Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b3c28adf6580f734851eaff09f2af6c64027e379c0d773e3139b83307d759d52"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/078a981f-c816-4c6c-a584-2c94f6831164/results/441287/?format=api",
            "id": 441287,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/12939176-a6cb-4744-bd8b-e58411b1291e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/078a981f-c816-4c6c-a584-2c94f6831164/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010722Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4d1b13c5023d894d9ec2251dc573b66fc72102084ced4e027ea02d27c529b33d"
        }
    ]
}