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/81d5415e-fcbd-40b9-afb7-dac4858a0f01/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/81d5415e-fcbd-40b9-afb7-dac4858a0f01/results/448106/?format=api",
            "id": 448106,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/448106/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/results/448107/?format=api",
            "id": 448107,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/106cc604-e0e4-4d00-96d7-b8d2ac09d325/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010254Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=ac9fa48586695f8de71fea67c37d2237ff79cb65e817cc6887f85bd067465c1e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/results/448108/?format=api",
            "id": 448108,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/51fad6c3-688f-4d32-a15e-285e82126d85/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010254Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=0aad023988413d8d1d1b9aa1bb5594a3ce799270e25668bd325443c623257c74"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/results/448109/?format=api",
            "id": 448109,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/732f5d71-ed87-440f-a751-819e7a141306/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010254Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1af1c44a671cee7ce3778d7fc66b695c57209666c67197ab829223c0b28abaeb"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/results/448110/?format=api",
            "id": 448110,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/5ce25961-0783-4aa3-92f4-a47ce82077b4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/81d5415e-fcbd-40b9-afb7-dac4858a0f01/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T010254Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=718d56cad5882f815bebba2f4e76291a185246c117f31aba30ea863c70aa337b"
        }
    ]
}