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/6f9ec418-ad43-4df1-85dd-8c0f2370f201/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/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441605/?format=api",
            "id": 441605,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/441605/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441618/?format=api",
            "id": 441618,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/8430cbda-0f6b-42b1-89ed-5777dbe1298e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011907Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=02dbfcf784c44d6f27df017cfdc2b1c6b567aa886608331f923c0bca79d6bb39"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441619/?format=api",
            "id": 441619,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/a0e05bdc-7e4a-46c5-89ed-57e393634d39/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011908Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7e3e399811f662cef3e501435d3fafb892a5aedf1672c10356297082e4c1a538"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441620/?format=api",
            "id": 441620,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/0250b414-650a-49a4-b828-c04676fda0ea/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011908Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2bdd9f03f0aef90c5d560afe5b71a81ac2c7bd46d0d13b4534d8a3ff694a00b4"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/results/441621/?format=api",
            "id": 441621,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/b7bc940e-e65d-4e09-ae68-b48c3901bfde/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/6f9ec418-ad43-4df1-85dd-8c0f2370f201/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T011908Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e09bf8295346efc1a87450d26d63bcde3e6bd0f34884ab50098ada473684de6f"
        }
    ]
}