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/265021da-c72b-40e2-83c4-9a0ec8bc2ebc/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/265021da-c72b-40e2-83c4-9a0ec8bc2ebc/results/449032/?format=api",
            "id": 449032,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449032/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/265021da-c72b-40e2-83c4-9a0ec8bc2ebc/results/449041/?format=api",
            "id": 449041,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/18dca337-42f2-4d7b-9480-8f13020a6384/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/265021da-c72b-40e2-83c4-9a0ec8bc2ebc/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192038Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5cf899160527151395a9fdf3fb9cfcd3861885f73c53600733b284aec48743df"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/265021da-c72b-40e2-83c4-9a0ec8bc2ebc/results/449042/?format=api",
            "id": 449042,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/2c6efcc9-c98d-4061-8b1f-ccf6ce38c729/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/265021da-c72b-40e2-83c4-9a0ec8bc2ebc/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192038Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5fa3c806c656e7cd6e9d78582bf58937c3570eae4b10c522e4d32896783a59b6"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/265021da-c72b-40e2-83c4-9a0ec8bc2ebc/results/449043/?format=api",
            "id": 449043,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/690a49e8-3829-430a-88d5-ae4473885fe1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/265021da-c72b-40e2-83c4-9a0ec8bc2ebc/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192038Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4e074a59e59c176799a1b21653cd6c4013c009e29aefc009c753c7ac75d66408"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/265021da-c72b-40e2-83c4-9a0ec8bc2ebc/results/449044/?format=api",
            "id": 449044,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/0d1d7be9-3d4b-42f2-a21b-3fcbf889acbb/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/265021da-c72b-40e2-83c4-9a0ec8bc2ebc/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T192038Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=314d20811d665ee404676bd56060da9dc1a520f4d797feed6a5c735f4a883124"
        }
    ]
}