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/ef9aa069-ff2f-41cb-996e-e03bf8602dd0/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/ef9aa069-ff2f-41cb-996e-e03bf8602dd0/results/440952/?format=api",
            "id": 440952,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/440952/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef9aa069-ff2f-41cb-996e-e03bf8602dd0/results/440977/?format=api",
            "id": 440977,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/cc7e4ef4-802e-4d16-b7f9-3c4eca9b8811/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ef9aa069-ff2f-41cb-996e-e03bf8602dd0/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T042810Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=7fbe3cd041478269c04d35ff74226ddbd681262072dc45881f83ca3ee16b22b6"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef9aa069-ff2f-41cb-996e-e03bf8602dd0/results/440978/?format=api",
            "id": 440978,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/d9b338f0-4e7a-4510-a60d-f4cfd1f71d42/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ef9aa069-ff2f-41cb-996e-e03bf8602dd0/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T042810Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=b78d20297070d9a4de289d602da7b157817420521663dfad8eb09c2e5b6a8a4f"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef9aa069-ff2f-41cb-996e-e03bf8602dd0/results/440979/?format=api",
            "id": 440979,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/e2800c83-6f55-4ef9-ac7a-b4e13eaca601/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ef9aa069-ff2f-41cb-996e-e03bf8602dd0/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T042810Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=4b82e4e2667f6958f8bbe769e3e083e5c844733aa1dfdc8b24b992ccb5770737"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/ef9aa069-ff2f-41cb-996e-e03bf8602dd0/results/440980/?format=api",
            "id": 440980,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/5982ccc4-7bfc-429c-9ef8-2ad8791b7901/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/ef9aa069-ff2f-41cb-996e-e03bf8602dd0/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250513%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250513T042810Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=85265cfcfe86c46b681c354d7419c8542f7b6d5e90945b0aa9e6f00e3f87311e"
        }
    ]
}