List permit documents
RoadPermit.list
Returns a list of permit documents. Without id and document_name, returns documents named "default". Aliases: get, listing.
Body parameters
| Body | Type | Description |
|---|---|---|
id | string | Document id. |
document_name | string | Group by document identifier. |
enviroment | string | Environment (default "uat"). |
Example request
{
"document_name": "ZDiK.TO.461.219.2020.AO"
}Example response
{
"result": [
{
"id": "60a79ba2",
"date_start": "2026-05-01",
"date_end": "2026-12-31",
"description": "Temporary HGV restriction.",
"document_name": "ZDiK.TO.461.219.2020.AO",
"location": "Tarnów Dąbrowskiego",
"permissions": {
"tr_tonnage": 24,
"tr_tonn_axis": 8.5
},
"is_valid_after_expiry": true
}
]
}result fields
| result fields | Type | Description |
|---|---|---|
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. |