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/1a0c8d43-fb44-4583-852d-324d7b62e2e0/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/1a0c8d43-fb44-4583-852d-324d7b62e2e0/results/449410/?format=api",
            "id": 449410,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449410/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1a0c8d43-fb44-4583-852d-324d7b62e2e0/results/449412/?format=api",
            "id": 449412,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/a9639f52-3c57-46e8-8e03-16af4a69a05a/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1a0c8d43-fb44-4583-852d-324d7b62e2e0/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T200053Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=15234651bd34a643c71b5506eed32b67ca16e5eed109a4a92233a6eabaafd40e"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1a0c8d43-fb44-4583-852d-324d7b62e2e0/results/449413/?format=api",
            "id": 449413,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/e556524e-ab0e-4f7b-9437-9b776bcf0c2d/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1a0c8d43-fb44-4583-852d-324d7b62e2e0/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T200053Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5ca0f287f507cbb83430d669af018df595b668b2c4c5c8be0385706268f41e76"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1a0c8d43-fb44-4583-852d-324d7b62e2e0/results/449414/?format=api",
            "id": 449414,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/3e15ff75-a8df-4f75-983d-19190aab71c0/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1a0c8d43-fb44-4583-852d-324d7b62e2e0/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T200053Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=8d2ec17dbf4d08e68f77c51093295dd98582896643ce75823acf52f0fe44bea1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/1a0c8d43-fb44-4583-852d-324d7b62e2e0/results/449415/?format=api",
            "id": 449415,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/24d9e0b9-1f38-4545-9857-fd5f77f26c67/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/1a0c8d43-fb44-4583-852d-324d7b62e2e0/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250512%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250512T200053Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=5b4b3773bcb6a62a99c32901af37d6a40ecb86d981a8cd9468fd888a9c019964"
        }
    ]
}