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/49f43ec7-6a28-4e06-8908-22c7d9bbd29b/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/49f43ec7-6a28-4e06-8908-22c7d9bbd29b/results/441326/?format=api",
            "id": 441326,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/441326/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/49f43ec7-6a28-4e06-8908-22c7d9bbd29b/results/441335/?format=api",
            "id": 441335,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/c949c9fe-66fa-48e2-af2f-a50fc28b9c87/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/49f43ec7-6a28-4e06-8908-22c7d9bbd29b/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010404Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=53def8bad96c675cf2ce1f0ce81f92969d3943c07ea61f006df896c2bb7bbcae"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/49f43ec7-6a28-4e06-8908-22c7d9bbd29b/results/441336/?format=api",
            "id": 441336,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/a010d7aa-d84f-4c73-a5fe-a26d8c9c9907/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/49f43ec7-6a28-4e06-8908-22c7d9bbd29b/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010404Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b43e368d0fe8e1d0b9d2fd081ab11893772d04542a28355ae6be38728be087d3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/49f43ec7-6a28-4e06-8908-22c7d9bbd29b/results/441337/?format=api",
            "id": 441337,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/c86181bd-5338-48f5-89f4-88a6671b3e3f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/49f43ec7-6a28-4e06-8908-22c7d9bbd29b/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010404Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e53cce23ed16ab3e9240915d6f0b48464e8f32d6d3bdc7146f26f72d5b8abb75"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/49f43ec7-6a28-4e06-8908-22c7d9bbd29b/results/441338/?format=api",
            "id": 441338,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/5722ea03-c9ea-468b-8210-be638267b3c1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/49f43ec7-6a28-4e06-8908-22c7d9bbd29b/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010404Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=d1f3d18782b41c6333a4434ee0fa84ba9c74dae6f1fbd87c87a39355a06b0107"
        }
    ]
}