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/09d0661c-84b9-4e32-a0cc-c093887acd50/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/09d0661c-84b9-4e32-a0cc-c093887acd50/results/440703/?format=api",
            "id": 440703,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/440703/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/09d0661c-84b9-4e32-a0cc-c093887acd50/results/440720/?format=api",
            "id": 440720,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/1af81da9-3284-41f7-b93c-1d925c7042ae/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/09d0661c-84b9-4e32-a0cc-c093887acd50/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T043540Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=cf9921114c45b608252195b495de7f681881bd8add6f32976c48d70e3b92ee12"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/09d0661c-84b9-4e32-a0cc-c093887acd50/results/440721/?format=api",
            "id": 440721,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/ed088972-3e3d-4c42-936c-d22f37d40cb0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/09d0661c-84b9-4e32-a0cc-c093887acd50/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T043540Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=f9055a10b07e5d139eb03cc3331622c7fc2a0e9463e2f8db7354d72acaca102d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/09d0661c-84b9-4e32-a0cc-c093887acd50/results/440722/?format=api",
            "id": 440722,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/86902c4d-ac36-42f0-9a96-6a468b58a497/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/09d0661c-84b9-4e32-a0cc-c093887acd50/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T043540Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=acd10bc8a56d578cadef9d900ba9272a9780a2f0dc54ef748cc3251dfe44ad38"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/09d0661c-84b9-4e32-a0cc-c093887acd50/results/440723/?format=api",
            "id": 440723,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/442fbe72-d813-4e40-b446-243a74bdc865/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/09d0661c-84b9-4e32-a0cc-c093887acd50/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T043541Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=3cf0c0b909af0e1fbb4c9fb15a1f6b90b54c9b656b5b16880771794fc5d7399c"
        }
    ]
}