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/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/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/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449764/?format=api",
            "id": 449764,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449764/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449774/?format=api",
            "id": 449774,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/84d38b18-ff7b-473e-bb7f-3908d8f0a994/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192727Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d9d08adf1a5345bca70a72c945e453728f452e38b52b160e7e1c78fbe356c040"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449775/?format=api",
            "id": 449775,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/567f6e79-540e-400e-8108-96b524a5e5d9/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192727Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a8bcd6d93cb54db4eae2be4435efd61900328a1a2c2b77b2e0c6457f56e395f0"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449776/?format=api",
            "id": 449776,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/add004e1-cbee-467a-9603-8ee1f649d334/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192727Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c689ddfe0ea162ef9e52c814528c4c710501ef80a37d2d7db5227c286e19e0c8"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/results/449777/?format=api",
            "id": 449777,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/0154905b-d136-4d2b-b9ab-043e1c235fd1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d0c78efd-1254-4fd2-9dbe-a59051eb6deb/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192727Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fb1a4fb1fc0b858ea19569fb07e66d9bd9e2fe2bb03ec2b8ba7c1c82eb0a6d0a"
        }
    ]
}