Api session items popups: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 102: Line 102:
ZIPSMILE:  
ZIPSMILE:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
==Api Model PopupData==
API Model description of PopupData
{|class=wikitable
!Name
!Type
!Description
|-
|answers
|Answer<nowiki>[]</nowiki>
|
|-
|calendar
|long
|
|-
|color
|TColor
|
|-
|id
|int
|
|-
|imageType
|PopupImageType
|
|-
|linkID
|int
|
|-
|linkType
|MapLink
|
|-
|modelDataID
|int
|[[Model Data]] ID
|-
|modelType
|PopupModelType
|
|-
|name
|String
|
|-
|opensAutomatically
|boolean
|
|-
|overrideAttention
|Boolean
|
|-
|point
|Point
|
|-
|polygons
|MultiPolygon
|
|-
|scale
|double
|
|-
|text
|String
|
|-
|title
|String
|
|-
|type
|Type
|
|-
|version
|int
|
|-
|visibleForStakeholderIDs
|int<nowiki>[]</nowiki>
|[[Stakeholder]] ID
|-
|visibleTimeframe
|int
|
|}
{{article end|seealso=*[[Api Content Items]]
{{article end|seealso=*[[Api Content Items]]
*[[Api session event editor]]
*[[Api session event editor]]

Revision as of 11:53, 20 April 2026

Api session items Popup Endpoints.

Default Query:

https://engine.tygron.com/api/session/items/popups/?f=JSON&token=API_TOKEN

Example Response:

[ {
  "answers" : [ ],
  "calendar" : null,
  "color" : {
    "argb" : -6704129
  },
  "id" : 0,
  "imageType" : "RECEIVE_REQUEST",
  "linkID" : 1,
  "linkType" : "PANELS",
  "modelDataID" : -1,
  "modelType" : "DECLINED",
  "name" : " 1",
  "opensAutomatically" : false,
  "overrideAttention" : true,
  "point" : {
    "type" : "Point",
    "coordinates" : [ 658907.9990757483, 6798948.801026824, 36.557 ]
  },
  "polygons" : null,
  "scale" : 1.0,
  "text" : "",
  "title" : "Text Panel",
  "type" : "INTERACTION",
  "version" : 3,
  "visibleForStakeholderIDs" : [ 0, 1, 2, 3, 4, 5 ],
  "visibleTimeframe" : 0
}, {
  "answers" : [ ],
  "calendar" : null,
  "color" : {
    "argb" : -19610
  },
  "id" : 1,
  "imageType" : "RECEIVE_REQUEST",
  "linkID" : 2,
  "linkType" : "PANELS",
  "modelDataID" : -1,
  "modelType" : "ELEVATION",
  "name" : " 2",
  "opensAutomatically" : false,
  "overrideAttention" : true,
  "point" : {
    "type" : "Point",
    "coordinates" : [ 659100.8960954784, 6799034.555303296, 80.804 ]
  },
  "polygons" : null,
  "scale" : 1.0,
  "text" : "",
  "title" : "Text Panel (2)",
  "type" : "INTERACTION",
  "version" : 6,
  "visibleForStakeholderIDs" : [ 0, 1, 2, 3, 4, 5 ],
  "visibleTimeframe" : 0
} ]

Limit Queries

version=100:

https://engine.tygron.com/api/session/items/popups/?version=100&token=API_TOKEN

Pseudo-Mercator:

https://engine.tygron.com/api/session/items/popups/?crs=3857&token=API_TOKEN

Degrees:

https://engine.tygron.com/api/session/items/popups/?crs=4326&token=API_TOKEN

Amersfoort / RD New:

https://engine.tygron.com/api/session/items/popups/?crs=28992&token=API_TOKEN

Local Coordinates:

https://engine.tygron.com/api/session/items/popups/?crs=LOCAL&token=API_TOKEN

bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785:

https://engine.tygron.com/api/session/items/popups/?crs=3857&bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785&token=API_TOKEN

FOO:

https://engine.tygron.com/api/session/items/popups-foo/?crs=3857&token=API_TOKEN

Show Queries

max version:

https://engine.tygron.com/api/session/items/popups/version/?token=API_TOKEN

size:

https://engine.tygron.com/api/session/items/popups/size/?token=API_TOKEN

Popups (GeoJSON):

https://engine.tygron.com/web/popups.geojson?crs=3857&bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785&token=API_TOKEN

Formats

HTML:

https://engine.tygron.com/api/session/items/popups/?f=HTML&token=API_TOKEN

JSON:

https://engine.tygron.com/api/session/items/popups/?f=JSON&token=API_TOKEN

GEOJSON:

https://engine.tygron.com/api/session/items/popups/?f=GEOJSON&token=API_TOKEN

GPKG:

https://engine.tygron.com/api/session/items/popups/?f=GPKG&token=API_TOKEN

DXF:

https://engine.tygron.com/api/session/items/popups/?f=DXF&token=API_TOKEN

CSV:

https://engine.tygron.com/api/session/items/popups/?f=CSV&token=API_TOKEN

SSV:

https://engine.tygron.com/api/session/items/popups/?f=SSV&token=API_TOKEN

SMILE:

https://engine.tygron.com/api/session/items/popups/?f=SMILE&token=API_TOKEN

ZIPJSON:

https://engine.tygron.com/api/session/items/popups/?f=ZIPJSON&token=API_TOKEN

ZIPSMILE:

https://engine.tygron.com/api/session/items/popups/?f=ZIPSMILE&token=API_TOKEN

Api Model PopupData

API Model description of PopupData

Name Type Description
answers Answer[]
calendar long
color TColor
id int
imageType PopupImageType
linkID int
linkType MapLink
modelDataID int Model Data ID
modelType PopupModelType
name String
opensAutomatically boolean
overrideAttention Boolean
point Point
polygons MultiPolygon
scale double
text String
title String
type Type
version int
visibleForStakeholderIDs int[] Stakeholder ID
visibleTimeframe int