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/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/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/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/results/452248/?format=api",
            "id": 452248,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/452248/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/results/452250/?format=api",
            "id": 452250,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/9ec24c74-4ad4-4631-861b-18028628d99d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062241Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=42ff0d86f4bd8b6c6fd118c36439db7de6bcba71c149f6e97268b551d8974aee"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/results/452251/?format=api",
            "id": 452251,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/b1cc623c-e740-4150-ad74-0da57186d639/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062241Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5081232fbbb072b351b1232fbbdb6d26e5a0b6baa2da4f4cdabbf0fd54315cee"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/results/452252/?format=api",
            "id": 452252,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/28e18064-e441-4c92-b548-f2d4e2d740e1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062241Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=93d598eb71c3ef368401f3c9dc0ef629d67424eefd31f36479e1e42c4af1ad45"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/results/452253/?format=api",
            "id": 452253,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/2e3540bf-ee00-4ad7-99a4-1da8f7a107ec/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/0e7263c7-370d-4a70-a9f7-4a1a6765b3b4/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062241Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=e44bc2631cc0c2c9a3452ab58d89b2fa4ca341b47442eb5287be14a2bf226bdf"
        }
    ]
}