Example API payload

AtlansApi allows a user to submit polygons for the area(s) of interest where settlement calculations are done for specified loading thicknesses. Additionally, a desired groundwater level can be specified, which is a uniform groundwater level for the area of interest in meters +NAP. These can be submitted as a JSON object by sending a POST request with application/json. A user can submit one or more polygons and each polygon should contain the attributes “id” and “dikte”. The map below shows the locations of two example polygons near the city of Almere. Hovering your mouse over one the polygons shows that they contain both the required attributes and the resulting JSON structure for the POST request is shown below the map.

API Endpoint and request body

The POST request should be submitted to the following endpoint:

POST /run

and the POST body should have the following structure:

{
    "gw": -5,
    "geojson": {
        "type": "FeatureCollection",
        "features": [
            {
                "id": "0",
                "type": "Feature",
                "properties": {
                    "id": 1,
                    "dikte": 1.5
                },
                "geometry": {
                    "type": "Polygon",
                    "coordinates": [
                        [
                            [137692, 487627],
                            [137787, 487840],
                            [138127, 487910],
                            [138295, 487791],
                            [138291, 487639],
                            [138156, 487426],
                            [137860, 487356],
                            [137672, 487451],
                            [137692, 487627]
                        ]
                    ]
                }
            },
            {
                "id": "1",
                "type": "Feature",
                "properties": {
                    "id": 2,
                    "dikte": 0.8
                },
                "geometry": {
                    "type": "Polygon",
                    "coordinates": [
                        [
                            [139087, 488123],
                            [139411, 487984],
                            [139403, 487762],
                            [139251, 487697],
                            [139042, 487849],
                            [139087, 488123]
                        ]
                    ]
                }
            }
        ],
        "crs": {
            "type": "name",
            "properties": {
                "name": "urn:ogc:def:crs:EPSG::28992"
            }
        }
    }
}

Field explanation

Field	Type	Description
gw	number	Groundwater level for the area of interest, in m above/below NAP
geojson	object	GeoJSON FeatureCollection
properties.id	integer	Unique identifier for each area
properties.dikte	number	Thickness (in m) for the area
geometry	Polygon	Coordinates that define the boundary of the area
crs	object	Coordinate Reference System (in this case EPSG:28992 / RD)

🔹Notes:

• All coordinates must be in Rijksdriehoekstelsel (RD) coordinates (EPSG:28992).
• The dikte can be defined individually for each polygon.
• The id in properties is used for internal identification.

Response

A succesful request responds with a JSON which contains a hash id of the user request and paths to tif output that contain the resulting subsidence, due to settlement, for two periods: “initial” and “remaining”. Below is an example JSON response:

{
    "id":"a1d6aeb4-f9b8-4b9f-be97-91c2e7d917e1",
    "initial":"./docker/output/a1d6aeb4-f9b8-4b9f-be97-91c2e7d917e1/initial.tif",
    "remaining":"./docker/output/a1d6aeb4-f9b8-4b9f-be97-91c2e7d917e1/remaining.tif"
}

Response status codes:

Code	Meaning
200	Success
400	Bad request (for example, missing gw or geojson)