Variable Name

Description

Example Value

Example Usage

Available for Template Type

external_user_data

Keycloak data of the customer for whom a Guardian submitted the request.

{
 "id": "customer-user-id",
 "username": "customer@example.com",
 "email": "customer@example.com",
 "firstName": "Max",
 "lastName": "Mustermann"
}

{#if external_user_data??}{external_user_data.firstName} {external_user_data.lastName}{#else}{#if user_data??}{user_data.firstName} {user_data.lastName}{#else}{user_id}{/if}{/if}

•Mail template

•Dynamic Documents

•Print Template

external_download_url

Customer-specific URL for downloading the result of a request submitted by a Guardian. This link will not require a login

https://<DOMAIN>/api-network-locator-gateway-vnlocator/download/extern/<SHORT-LIVED-TOKEN>

{#if external_download_url??}{external_download_url}{#else}{download_url}{/if}

•Mail template

download_url

Standard URL to download the request result.

https://<DOMAIN>/api-network-locator-gateway-vnlocator/download/locator-result@2026-3.zip

<a href="{download_url}" >Download</a>

•Mail template

user_data

Keycloak user data

{
   "lastName": "Test",
   "resource_access": {
       "account": {
           "roles": [
               "manage-account",
               "manage-account-links",
               "view-profile"
           ]
       }
   },
   "address": {
       "street_address": "MyStreet",
       "locality": "MyCity",
       "postal_code": "1000",
       "country": "MyCountry"
   },
   "organisation": "MyOrg",
   "preferred_username": "test@vertigis.com",
   "given_name": "Mustermann",
   "firstName": "Max",
   "name": "Max Mustermann",
   "company": "MyComp",
   "department": "MyDepart",
   "family_name": "Mustermann",
   "email": "test@vertigis.com",
   "username": "max.mustermann@vertigis.com"
}

z.H. {#if user_data??}{user_data.username}{#else}{user_id}

•Mail template

•Dynamic Documents

•Print Template

user_id

Technical Keycloak user ID. Used as a fallback when user data is not available.

653a89bd6d5e9e739e76632c

{#if user_data??}{user_data.username}{#else}{user_id}{/if}

•Mail template

•Dynamic Documents

•Print Template

request

Client request parameter

{
   "address": {

    "postal": "10117",

    "city": "Berlin",

    "district": "Mitte",

    "street": "Margarete-Steffin-Straße",

    "housenumber": "25"

 },

    "geometry": {
       "x": 1489343.8646368028,
       "y": 6895227.7146663656,
       "spatialReference": {
           "wkid": 102100,
           "latestWkid": 3857
       }
   },
   "export_formats": ["PDF", "DXF],

   "info": "Test",
   "template": "vglaypk_7b81d88dcb574be9b602506f1c9af31e",
   "scale": 250.0,
   "start_date": 1758326400.0,
   "print_pages": [
       {
           "rotation": 0.0,
           "scale": 410.88356846344618,
           "centerX": 1489343.864636803,
           "centerY": 6895227.7146663666,
           "geometry": {
               "rings": [
                   [..]
           },
           "spatialReference": {
               "wkid": 3857
           }
       }
   ],
   "purpose": "Akquise",
   "request_id_parent": ""
}

Request Remark: {request.info}

Request Purpose: {request.purpose}

•Mail template

•Dynamic Documents

•Print Template

currentDate

Current Date Time

{time:format(global:currentDate,'dd.MM.yyyy',global:locale,global:zoneId)}

•Mail template

•Dynamic Documents

•Print Template

group_results

Intersection results

[
   {
       "print_pages_with_intersections": [
           {
               "rotation": 0.0,
               "scale": 410.88356846344618,
               "centerX": 1489343.864636803,
               "centerY": 6895227.7146663666,
               "geometry": {
                   "rings": [
                       [...]
                   ]
               },
               "spatialReference": {
                   "wkid": 3857
               },
               "affected": true,
               "affectedLayers": [
                   "gas.subnet-line"
               ]
           }
       ],
       "static_documents": [
       ],
       "has_intersection": true,
       "files": [
           "locator-work@756277cc-b985-4e16-9997-cd10711239e9@Gas.pdf"
       ],
       "negative_reply": null,
       "affected_intersection_layers": [
           {
               "layer": "gas.subnet-line",
               "features": [
               ]
           }
       ],
       "uploaded_negative_reply": [
       ],
       "group_id": "gas",
       "print_files": [
           "locator-work@756277cc-b985-4e16-9997-cd10711239e9@Gas.pdf"
       ],
       "intersection_layers": [
           "gas.subnet-line"
       ]
   },
   {
       "print_pages_with_intersections": [
           {
               "rotation": 0.0,
               "scale": 410.88356846344618,
               "centerX": 1489343.864636803,
               "centerY": 6895227.7146663666,
               "geometry": {
                   "rings": [
                       [...]
                   ]
               },
               "spatialReference": {
                   "wkid": 3857
               },
               "affected": true,
               "affectedLayers": [
                   "electricity.subnet-line"
               ]
           }
       ],
       "static_documents": [
       ],
       "has_intersection": true,
       "files": [
           "locator-work@756277cc-b985-4e16-9997-cd10711239e9@Strom.pdf"
       ],
       "negative_reply": null,
       "affected_intersection_layers": [
           {
               "layer": "electricity.subnet-line",
               "features": [
                   {
                       "objectid": 6
                   },
                   {
                       "objectid": 12
                   }
               ]
           }
       ],
       "uploaded_negative_reply": [
       ],
       "group_id": "electricity",
       "print_files": [
           "locator-work@756277cc-b985-4e16-9997-cd10711239e9@Strom.pdf"
       ],
       "intersection_layers": [
           "electricity.subnet-line",
           "electricity.Hochspannung",
           "electricity.Prohibited-Area"
       ]
   }
]

Not Affected Branches: {#for group_result in group_results}{#if group_result.has_intersection is false}{group_result.group_id}, {/if}{/for}

•Mail template

•Dynamic Documents

display_id

Human-readable ID of the locate request.

2026-1462

Request ID: {display_id}

•Mail template

•Dynamic Documents

•Print Template

request_id

Internal technical ID of the locate request. Use display_id for user-facing references.

653a89bd6d5e9e739e76632c

Request-ID: {request_id}

•Mail template

•Dynamic Documents

•Print Template

agent_comment

Stores the agent's message from the manual approval of requests intersecting a locked area.

The request has been approved by an internal agent. You are good to dig in this area but read the special high voltage instructions.

{#if agent_comment??}Notice regarding the release of documents: {agent_comment}

{/if}

•Mail template

•Dynamic Documents

•Print Template

affected_groups

Holds only the affected intersection groups

[­"electricity","gas"]
 

Number of affected branches: {affected_groups.size()}`

•Mail template

•Dynamic Documents

•Print Template

added_static_documents

Holds all the static documents that are part of a request

[
  "locator-document@request-info.pdf",
  "locator-document@terms-and-conditions.pdf"
]

Number of static documents: {added_static_documents.size()}

•Mail template

•Dynamic Documents

dynamic_documents_number

Holds the number of dynamic documents that are created with this request

2

Anzahl der dynamischen Dokumente: {dynamic_documents_number}

•Dynamic Documents

error_message

Error message generated while processing a request.

The request could not be processed.

{error_message}

•Mail template

user_email

Email address of the user who submitted the request.

user@example.com

{user_email}

•Mail template

user_role

Active role of the user who submitted the request.

vnl_acc_user

{user_role}

•Mail template