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/95efc565-7a7c-4eb2-ba58-43b789b544da/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/95efc565-7a7c-4eb2-ba58-43b789b544da/results/448969/?format=api",
            "id": 448969,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/448969/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/95efc565-7a7c-4eb2-ba58-43b789b544da/results/448971/?format=api",
            "id": 448971,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/aa20683b-41f7-4a73-96cd-0d00fee21627/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/95efc565-7a7c-4eb2-ba58-43b789b544da/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T165845Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=94eac9629bcad857818f8d26dc44aced7a682aa6b95419df99c2ad02c79cfa5c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/95efc565-7a7c-4eb2-ba58-43b789b544da/results/448972/?format=api",
            "id": 448972,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/139ec4dc-1a97-4b4e-a737-076ee9053d81/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/95efc565-7a7c-4eb2-ba58-43b789b544da/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T165845Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b363c979724a5504657130daaf52a3c1cb533bcac875dfa5142652e31258f699"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/95efc565-7a7c-4eb2-ba58-43b789b544da/results/448973/?format=api",
            "id": 448973,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/daa885d8-9065-41d9-ab12-4bcfa963e463/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/95efc565-7a7c-4eb2-ba58-43b789b544da/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T165845Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=53aceb662dcd4cb09c21dc6e8ba24574b8283861b9687ea7d79f0ccfab23b1fa"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/95efc565-7a7c-4eb2-ba58-43b789b544da/results/448974/?format=api",
            "id": 448974,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/f61dbda6-bd03-4f6d-b7a4-d7886823d8f1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/95efc565-7a7c-4eb2-ba58-43b789b544da/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T165845Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5bc24da1db7d657bb70d30255094ede8c73188e8b33f28136f6126da9579a8bd"
        }
    ]
}