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/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/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/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/results/455952/?format=api",
            "id": 455952,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/455952/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/results/455953/?format=api",
            "id": 455953,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/3ac0fff7-55a0-4492-a853-811baf6dfeb8/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062950Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=12de47b07a82f16fafb4860b2f539bfa275054187bd599fb21516531064fd055"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/results/455954/?format=api",
            "id": 455954,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/e7fc3ffd-6c56-47f2-9913-a42588b40300/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062950Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c4bd47c8d488cf153beb633d32f0cd3cb00208ea628a903adf7562961a01428f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/results/455955/?format=api",
            "id": 455955,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/12acfd23-9e23-4f4d-83b8-ff403d96711f/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062950Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=cd4a058aa122e45003fde70f12539a177b5d439b29511e5973779fa02057ec5a"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/results/455956/?format=api",
            "id": 455956,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/f1899c6f-e271-4c55-8e4a-daff24773a70/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/f9fa1eca-cfd9-48bf-a86d-1dd8e472cdde/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062950Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=fdce6da6aaf7f5091254fd0ea3c9f0dfd22480c2c380f899ed54a61944c709b8"
        }
    ]
}