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/6fc057c8-16cf-43d1-9672-6fa51a88f8f2/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/6fc057c8-16cf-43d1-9672-6fa51a88f8f2/results/449286/?format=api",
            "id": 449286,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449286/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6fc057c8-16cf-43d1-9672-6fa51a88f8f2/results/449287/?format=api",
            "id": 449287,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/332d702f-79fe-4a22-be9f-a7d43b5ae8ed/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6fc057c8-16cf-43d1-9672-6fa51a88f8f2/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T155738Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=370eb01e61e89c88a6c827cbde544d57a93415d35c3d6ebd331cc4d9226e7985"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6fc057c8-16cf-43d1-9672-6fa51a88f8f2/results/449288/?format=api",
            "id": 449288,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/76e8c719-a68a-43a1-bf76-aba67fa0f3c2/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6fc057c8-16cf-43d1-9672-6fa51a88f8f2/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T155738Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8fa4bc04731ea0784d4a45c82a79ee0cb9ac6db7bfe561187c9078fc6e24779b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6fc057c8-16cf-43d1-9672-6fa51a88f8f2/results/449289/?format=api",
            "id": 449289,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/d3759d85-5c29-4ea0-975e-63219f6307b5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6fc057c8-16cf-43d1-9672-6fa51a88f8f2/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T155738Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e98af0e107ed2e1cba92fcea8dde04e969796a2bf0afc40c6f20d55cab18bf0f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6fc057c8-16cf-43d1-9672-6fa51a88f8f2/results/449290/?format=api",
            "id": 449290,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/faf7bb80-12cf-444c-ab17-4655fcd92757/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6fc057c8-16cf-43d1-9672-6fa51a88f8f2/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T155738Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7029aba3afb5a3255b68e9a202538fabb08211d6c006f420e953883cea82297e"
        }
    ]
}