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/0c13aab7-36b0-4ae7-a450-7a03aee015bd/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/0c13aab7-36b0-4ae7-a450-7a03aee015bd/results/453569/?format=api",
            "id": 453569,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/453569/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0c13aab7-36b0-4ae7-a450-7a03aee015bd/results/453579/?format=api",
            "id": 453579,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/837b3600-cee7-46cc-a561-27e5a6cceff3/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0c13aab7-36b0-4ae7-a450-7a03aee015bd/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250316%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250316T081259Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4d310a27bea7ebf6cc0b7cc9969b1f5445012f0786cfdadc9c5b50f50bacfc4d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0c13aab7-36b0-4ae7-a450-7a03aee015bd/results/453580/?format=api",
            "id": 453580,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/c326f8ad-0074-4720-9077-39a16b31405d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0c13aab7-36b0-4ae7-a450-7a03aee015bd/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250316%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250316T081259Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1de9ca6a8d291feea059ba3122298dd6da0fa9f4f8bafe5981d5a20e1940df19"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0c13aab7-36b0-4ae7-a450-7a03aee015bd/results/453581/?format=api",
            "id": 453581,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/d26f4803-6cd2-43b2-bae1-fdad0a84725f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0c13aab7-36b0-4ae7-a450-7a03aee015bd/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250316%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250316T081259Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1ccb9dd23c5e41729cba28e8163bc96c3629b8abc965b108a161d5086fc1d2f8"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0c13aab7-36b0-4ae7-a450-7a03aee015bd/results/453582/?format=api",
            "id": 453582,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/44bbc8a3-a37d-4cc9-a35c-30552f598b7b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0c13aab7-36b0-4ae7-a450-7a03aee015bd/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250316%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250316T081259Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=43d37ccf1d3df8e22c01713a8066395000e823bb9cf95109a98f325c5536cd86"
        }
    ]
}