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/69d0f39b-cac2-4af4-8fb5-b3d59308bda4/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/69d0f39b-cac2-4af4-8fb5-b3d59308bda4/results/440881/?format=api",
            "id": 440881,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/440881/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/69d0f39b-cac2-4af4-8fb5-b3d59308bda4/results/440886/?format=api",
            "id": 440886,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/407907c3-056a-4e55-8c5e-5da3d2ac7ba7/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/69d0f39b-cac2-4af4-8fb5-b3d59308bda4/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T005428Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fd5a1ef7aa6393ff9c8d0ce18e8116d813611050e4aa6bb187d302462a060d7d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/69d0f39b-cac2-4af4-8fb5-b3d59308bda4/results/440887/?format=api",
            "id": 440887,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/5e5bfdf7-508b-42bf-88d4-e844e8baf728/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/69d0f39b-cac2-4af4-8fb5-b3d59308bda4/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T005428Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c5bf8c527e83e480541a477b7de6a60e69c03cc2e2f29afb587e33f714118161"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/69d0f39b-cac2-4af4-8fb5-b3d59308bda4/results/440888/?format=api",
            "id": 440888,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/eb4b8f0c-3bd9-4823-a214-c0e16298a33b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/69d0f39b-cac2-4af4-8fb5-b3d59308bda4/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T005428Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=2e6e591e26e2e6ecdcf35a99d616d2e99f268167a99e9d401c99564e3fe07afe"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/69d0f39b-cac2-4af4-8fb5-b3d59308bda4/results/440889/?format=api",
            "id": 440889,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/c1172d9f-ff28-47d1-9ab4-2e928b765f49/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/69d0f39b-cac2-4af4-8fb5-b3d59308bda4/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T005428Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=922951c891e8759fe8f651fc9b4936f767dba64fc058f0db479089b288a488c2"
        }
    ]
}