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/220d2115-4b4d-43ba-8872-7101b2e9a0b7/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/220d2115-4b4d-43ba-8872-7101b2e9a0b7/results/385175/?format=api",
            "id": 385175,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/385175/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/results/385176/?format=api",
            "id": 385176,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/ac1c90b6-8d07-43ee-af95-2a5b4be6ba24/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T121811Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e84a057b59082d23bfaf2262a1701f8ca088e4c24a7d7045f3ddc2bfd9e83614"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/results/385177/?format=api",
            "id": 385177,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/4854a342-0ee1-442c-9f1f-8a3d7256af75/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T121811Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=49d98da08086f640f65e47dcf143dbe25d43be4e7c8c3d4e3c72488d1932cf93"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/results/385178/?format=api",
            "id": 385178,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/993b50ea-dd7b-4a50-b903-0df241b3024c/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T121811Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0b52134ea3a8c76c60dbccb6df78eba059f33afe333c7c0d5b4edce65350fc23"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/results/385179/?format=api",
            "id": 385179,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/e88942d6-3715-4abc-8bd7-2513e0a8862a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/220d2115-4b4d-43ba-8872-7101b2e9a0b7/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T121811Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=70edf91405dbc09f69dc2c009d92a252a9510b4aebc6697ca6ca7bd808856755"
        }
    ]
}