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/cd618165-e012-48a4-a8a2-d7d2f035bebd/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/cd618165-e012-48a4-a8a2-d7d2f035bebd/results/449780/?format=api",
            "id": 449780,
            "name": "Damage summary (csv)",
            "code": "damage-summary",
            "description": null,
            "family": "Damage",
            "raster": null,
            "attachment_url": "https://demo.lizard.net/api/v4/scenario-results/449780/damage-summary.csv?format=api",
            "upload_url": null
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/cd618165-e012-48a4-a8a2-d7d2f035bebd/results/449789/?format=api",
            "id": 449789,
            "name": "Damage (direct)",
            "code": "direct-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/dc38ab17-865d-4967-8230-6c3a581c46a1/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/cd618165-e012-48a4-a8a2-d7d2f035bebd/direct-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062504Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=9e0d7a33638d9c19b7690d7c31fe0ccc5a81319d31f1e052d3ccc7d452ec6d0d"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/cd618165-e012-48a4-a8a2-d7d2f035bebd/results/449790/?format=api",
            "id": 449790,
            "name": "Waterdepth (damage)",
            "code": "dmge-depth",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/19d8637e-844a-4731-bd0b-8f8936d5852b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/cd618165-e012-48a4-a8a2-d7d2f035bebd/dmge-depth-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062504Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=c8026972b0fd7e318b311a058ef86a8412405526de573656da2427152c11c6c1"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/cd618165-e012-48a4-a8a2-d7d2f035bebd/results/449791/?format=api",
            "id": 449791,
            "name": "Damage (indirect)",
            "code": "indirect-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/09d0ade4-0cb4-48b5-a994-1565230aeeb4/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/cd618165-e012-48a4-a8a2-d7d2f035bebd/indirect-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062504Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=a8533d293338ad642ffd50c04b4190e78e26c6962d1153d3d99a79cb38766327"
        },
        {
            "url": "https://demo.lizard.net/api/v4/scenarios/cd618165-e012-48a4-a8a2-d7d2f035bebd/results/449792/?format=api",
            "id": 449792,
            "name": "Total damage",
            "code": "total-damage",
            "description": null,
            "family": "Damage",
            "raster": "https://demo.lizard.net/api/v4/rasters/66ea3af9-b17e-4ee2-a141-a37f200f8f5b/?format=api",
            "attachment_url": null,
            "upload_url": "https://lizard-prod.s3.amazonaws.com/scenarios/cd618165-e012-48a4-a8a2-d7d2f035bebd/total-damage-upload?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2FOYZ3A3OWTIUOHB%2F20250315%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20250315T062504Z&X-Amz-Expires=604800&X-Amz-SignedHeaders=host&X-Amz-Signature=261746b3aeb7c7ce135fbefc2ab57ef5bff077e7b3378be199d1a8790a1de563"
        }
    ]
}