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/1f545426-139a-4347-9da9-a07bd6b64cc4/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/1f545426-139a-4347-9da9-a07bd6b64cc4/results/441667/?format=api",
            "id": 441667,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/441667/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1f545426-139a-4347-9da9-a07bd6b64cc4/results/441669/?format=api",
            "id": 441669,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/dce82015-4c5e-43d9-a7ec-b0bcc95ee961/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1f545426-139a-4347-9da9-a07bd6b64cc4/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T220444Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b9eb415f31ff5b43f6cda8f33f58fcc6ff878a87be4ad072d2135ab027c830f3"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1f545426-139a-4347-9da9-a07bd6b64cc4/results/441670/?format=api",
            "id": 441670,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/e1ac4706-db68-4b17-9dbb-e28f165b7e98/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1f545426-139a-4347-9da9-a07bd6b64cc4/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T220444Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c87f825f40138edbfb674576c2612396ac5fb12788955c13e69015603e8c5d3c"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1f545426-139a-4347-9da9-a07bd6b64cc4/results/441671/?format=api",
            "id": 441671,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/dab457a7-a1e7-4534-a310-c52e54f2a9a5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1f545426-139a-4347-9da9-a07bd6b64cc4/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T220444Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=cc1bffb1ac87db609bfae62cd82ef2e4690bc2521c7d67815ffb5c4a2ca60b26"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1f545426-139a-4347-9da9-a07bd6b64cc4/results/441672/?format=api",
            "id": 441672,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/75def64e-6823-42c8-a659-2f2f22169a30/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1f545426-139a-4347-9da9-a07bd6b64cc4/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T220444Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=82bc6b559c9054cd0754336a3c36a1b762fd6bb6c67ca7f165104ab9f995697f"
        }
    ]
}