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/d076586f-fdbb-4cc0-be13-8987f7d28b96/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/d076586f-fdbb-4cc0-be13-8987f7d28b96/results/441140/?format=api",
            "id": 441140,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/441140/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d076586f-fdbb-4cc0-be13-8987f7d28b96/results/441142/?format=api",
            "id": 441142,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/e61d17c7-024e-4eb1-a29d-0b0a714c3a29/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d076586f-fdbb-4cc0-be13-8987f7d28b96/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=3424c23f53f5d6d694deea67c4eb6db79de1ee6c78df9379b411f42bc0c61fed"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d076586f-fdbb-4cc0-be13-8987f7d28b96/results/441143/?format=api",
            "id": 441143,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/002676e9-0dd5-4288-8709-bc19e4d93e63/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d076586f-fdbb-4cc0-be13-8987f7d28b96/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=393c9e6111678cfb8570956084b85a381b6670b2dc7dd0238a0a9c0bf6c8d9c6"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d076586f-fdbb-4cc0-be13-8987f7d28b96/results/441144/?format=api",
            "id": 441144,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/5d787def-910d-4e9c-bae4-b3b37add08c5/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d076586f-fdbb-4cc0-be13-8987f7d28b96/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=aae2657faaf7bc92f9fcaa319cb1c48a5a791e4ca920c17c7dc478b0d7990740"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/d076586f-fdbb-4cc0-be13-8987f7d28b96/results/441145/?format=api",
            "id": 441145,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/ebddf75c-5ce3-4230-89c0-20ed9bf0907d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/d076586f-fdbb-4cc0-be13-8987f7d28b96/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=170a2549c9c231841dcb63ff3f9b6cc7b9a0b7c204414cce87eb68a6e480c6a6"
        }
    ]
}