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/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/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/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/results/452394/?format=api",
            "id": 452394,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452394/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/results/452399/?format=api",
            "id": 452399,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/6448b968-4d8b-4d4e-8355-c5222442e138/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T104535Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2208615856dc4ec87ffa3f835d09f6f17eb56667d9221e4caf62099c08554a89"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/results/452400/?format=api",
            "id": 452400,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/200186ab-1c3c-45b9-b4a0-74ee1ddff4ac/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T104535Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=611140a7245d49c66db34c8b4451b0c1ab25819c331a473e3a128bdf10a85e06"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/results/452401/?format=api",
            "id": 452401,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/cc820d49-1f29-4e9b-a95c-1eb9b170aa05/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T104535Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=470908d788bdd9e02965f7507767b61444889e0b65f1a8e42f4a98987f70c45a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/results/452402/?format=api",
            "id": 452402,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/93c23c4a-faa1-4fdd-9701-bee6fa76188f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/545b2dfc-b73f-4aa6-b8f5-4fb108cc14b2/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T104535Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c66b1d1d299e71b54b70f8ea94f82644dfb2ca2a405f514f37d87ec037a03083"
        }
    ]
}