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/a16cf582-498d-4baf-a9c8-99a87804c9fa/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/a16cf582-498d-4baf-a9c8-99a87804c9fa/results/448171/?format=api",
            "id": 448171,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/448171/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a16cf582-498d-4baf-a9c8-99a87804c9fa/results/448172/?format=api",
            "id": 448172,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/38505a09-7333-4f11-a682-fc6b3103ad87/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a16cf582-498d-4baf-a9c8-99a87804c9fa/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T014430Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=6ed72e37504a073487df62ab313bd82ffe22513d14088518cb14599d374562f9"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a16cf582-498d-4baf-a9c8-99a87804c9fa/results/448173/?format=api",
            "id": 448173,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/86072cb4-8d60-4d92-a186-286a9c667ab9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a16cf582-498d-4baf-a9c8-99a87804c9fa/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T014430Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=43d3b05fdfb79ac96f3ac58b497660e445ca73ce027638ff8007e3d780e537e7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a16cf582-498d-4baf-a9c8-99a87804c9fa/results/448174/?format=api",
            "id": 448174,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/a9f99337-0b16-4a40-af29-0ad490559cfd/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a16cf582-498d-4baf-a9c8-99a87804c9fa/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T014430Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=757e616b9ef67d7f8d798d2e588ca28105b87518d21bfbb3e69da0e7c8d6b007"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a16cf582-498d-4baf-a9c8-99a87804c9fa/results/448175/?format=api",
            "id": 448175,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/102a7d41-0e68-4fd3-b5f4-3c979d629be6/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a16cf582-498d-4baf-a9c8-99a87804c9fa/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T014430Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b42b2f6787800f15b54453b3282459bf90ae7149f977979f908b697fd8ada2af"
        }
    ]
}