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/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/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/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/results/448188/?format=api",
            "id": 448188,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/448188/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/results/448189/?format=api",
            "id": 448189,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/5bace318-c6ce-42c5-9a35-4f23e61a9f2f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T013827Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=1af1e52fb1a9a643108a09d9042466078bdf179370c4dc937e8d5737999e851b"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/results/448190/?format=api",
            "id": 448190,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/2f93263f-2e83-4fa8-af1a-d4a8628c5b4e/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T013827Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=62f9c902bc307a41c9b52edc48cf747450fada26aa70292082e18cda057acbf7"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/results/448191/?format=api",
            "id": 448191,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/a382938e-78dd-4961-8e2c-9ab897ca2860/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T013827Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=acbd071f222658bfc97e929d631389d8d7689fd6f9d851102a7bc00783753740"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/results/448192/?format=api",
            "id": 448192,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/6a96cec2-2aec-466f-9301-0b7f7f358d00/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/a3c26bd4-baa6-4a58-b1a3-953f928fd45f/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T013827Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=12fcc3ee2b29c082e44a4704c130d14d47784800481f5dd82e0448aa3a0a18d2"
        }
    ]
}