Overwrite permit document
RoadPermit.overwrite
Replaces the entire document identified by id. Alias: update.
Body parameters
| Body | Type | Description |
|---|---|---|
id | string REQUIRED | Document id. |
enviroment | string | Environment name (default "uat"). Letters, digits, _, -. |
date_start | string | Validity start "YYYY-MM-DD". |
date_end | string | Validity end "YYYY-MM-DD"; must be ≥ date_start. |
description | string | Free-text description (≤ 255 chars). |
document_name | string | Document identifier (default "default"). |
location | string | Location description. |
permissions | object | At least one of tr_tonnage / tr_tonn_axis / tr_height. |
tr_tonnage | integer|double | Allowed tonnage. |
tr_tonn_axis | integer|double | Allowed axle load. |
tr_height | integer|double | Allowed height. |
poly | object | GeoJSON Polygon { type: "Polygon", coordinates: [[[lon,lat], …]] }. |
is_valid_after_expiry | bool | Keep valid after date_end. Default true. |
Example request
{
"id": "60a79ba2",
"enviroment": "uat",
"date_start": "2026-05-01",
"date_end": "2027-01-31",
"is_valid_after_expiry": false,
"permissions": {
"tr_tonnage": 26,
"tr_tonn_axis": 9
},
"poly": {
"type": "Polygon",
"coordinates": [
[
[
20.993,
50.0106
],
[
20.9945,
50.0108
],
[
20.9942,
50.0116
],
[
20.9931,
50.0119
],
[
20.993,
50.0106
]
]
]
}
}Example response
{
"result": {
"id": "60a79ba2"
}
}result fields
| result fields | Type | Description |
|---|---|---|
id | string | Id of the overwritten document. |