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/c0c5ac18-6754-4500-9e40-7c68ce2e3eb7/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/c0c5ac18-6754-4500-9e40-7c68ce2e3eb7/results/449526/?format=api",
            "id": 449526,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449526/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c0c5ac18-6754-4500-9e40-7c68ce2e3eb7/results/449527/?format=api",
            "id": 449527,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/d4213b4c-4552-4b2b-963a-b0bf594875a5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c0c5ac18-6754-4500-9e40-7c68ce2e3eb7/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T112254Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e061860bee95e19762243a9df111f72fe7656f31404e33619a9b22ec76fdeb6d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c0c5ac18-6754-4500-9e40-7c68ce2e3eb7/results/449528/?format=api",
            "id": 449528,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/7800f61d-a90b-49c2-8d93-3f4c1fa8f389/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c0c5ac18-6754-4500-9e40-7c68ce2e3eb7/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T112254Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=de2e5d0cff2cdbf5140d7acc5ffcf0245bed214fb35f29e7d7c51b792965a2e7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c0c5ac18-6754-4500-9e40-7c68ce2e3eb7/results/449529/?format=api",
            "id": 449529,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/b5728a5b-c462-420a-b2a5-1052af3b1032/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c0c5ac18-6754-4500-9e40-7c68ce2e3eb7/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T112254Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=67f9aa44bebbc5b4842e702b5cc13239a5e013464dc48269a9637c253a3163fa"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/c0c5ac18-6754-4500-9e40-7c68ce2e3eb7/results/449530/?format=api",
            "id": 449530,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/f51a02bc-e751-4e07-81e9-e51ceb47f1a4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/c0c5ac18-6754-4500-9e40-7c68ce2e3eb7/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T112254Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5507a2079c9f62bccdf19756765ecf34c28da3ae500df83df1dbd1fc2cdf6bf5"
        }
    ]
}