Api session items popups: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
46,429 edits
No edit summary
No edit summary
 
(32 intermediate revisions by the same user not shown)
Line 1: Line 1:
api session items [[Popup]] Endpoints.
API Endpoint: /api/session/items/popups/
 
Manipulate items with event: [[Api session event editor |Api session event editor ]].


Default Query:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=JSON&token=API_TOKEN</syntaxhighlight>
Example Response:
<syntaxhighlight lang="text" copy>[ {
  "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
} ]</syntaxhighlight>
==Limit Queries==
==Limit Queries==
version=100:  
version=100:  
<pre>https://engine.tygron.com/api/session/items/popups/?version=100&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?version=100&token=API_TOKEN</syntaxhighlight>
Pseudo-Mercator:  
Pseudo-Mercator:  
<pre>https://engine.tygron.com/api/session/items/popups/?crs=3857&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?crs=3857&token=API_TOKEN</syntaxhighlight>
Degrees:  
Degrees:  
<pre>https://engine.tygron.com/api/session/items/popups/?crs=4326&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?crs=4326&token=API_TOKEN</syntaxhighlight>
Amersfoort / RD New:  
Amersfoort / RD New:  
<pre>https://engine.tygron.com/api/session/items/popups/?crs=28992&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?crs=28992&token=API_TOKEN</syntaxhighlight>
Local Coordinates:  
Local Coordinates:  
<pre>https://engine.tygron.com/api/session/items/popups/?crs=LOCAL&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?crs=LOCAL&token=API_TOKEN</syntaxhighlight>
bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785:  
bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785:  
<pre>https://engine.tygron.com/api/session/items/popups/?crs=3857&bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?crs=3857&bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785&token=API_TOKEN</syntaxhighlight>
FOO:  
FOO:  
<pre>https://engine.tygron.com/api/session/items/popups-foo/?crs=3857&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups-foo/?crs=3857&token=API_TOKEN</syntaxhighlight>
==Show Queries==
==Get Queries==
attributes:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/attributes/?token=API_TOKEN</syntaxhighlight>
max version:  
max version:  
<pre>https://engine.tygron.com/api/session/items/popups/version/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/version/?token=API_TOKEN</syntaxhighlight>
size:  
count:  
<pre>https://engine.tygron.com/api/session/items/popups/size/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/count/?token=API_TOKEN</syntaxhighlight>
Popups (GeoJSON):
<pre>https://engine.tygron.com/web/popups.geojson?crs=3857&bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785&token=API_TOKEN</pre>
==Formats==
==Formats==
HTML:  
HTML:  
<pre>https://engine.tygron.com/api/session/items/popups/?f=HTML&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=HTML&token=API_TOKEN&crs=3857</syntaxhighlight>
JSON:  
JSON:  
<pre>https://engine.tygron.com/api/session/items/popups/?f=JSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=JSON&token=API_TOKEN&crs=3857</syntaxhighlight>
GEOJSON:  
GEOJSON:  
<pre>https://engine.tygron.com/api/session/items/popups/?f=GEOJSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=GEOJSON&token=API_TOKEN&crs=3857</syntaxhighlight>
GPKG:  
GPKG:  
<pre>https://engine.tygron.com/api/session/items/popups/?f=GPKG&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=GPKG&token=API_TOKEN&crs=3857</syntaxhighlight>
DXF:  
DXF:  
<pre>https://engine.tygron.com/api/session/items/popups/?f=DXF&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=DXF&token=API_TOKEN&crs=3857</syntaxhighlight>
CSV:  
CSV:  
<pre>https://engine.tygron.com/api/session/items/popups/?f=CSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=CSV&token=API_TOKEN&crs=3857</syntaxhighlight>
SSV:  
SSV:  
<pre>https://engine.tygron.com/api/session/items/popups/?f=SSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=SSV&token=API_TOKEN&crs=3857</syntaxhighlight>
SMILE:  
SMILE:  
<pre>https://engine.tygron.com/api/session/items/popups/?f=SMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=SMILE&token=API_TOKEN&crs=3857</syntaxhighlight>
ZIPJSON:  
ZIPJSON:  
<pre>https://engine.tygron.com/api/session/items/popups/?f=ZIPJSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=ZIPJSON&token=API_TOKEN&crs=3857</syntaxhighlight>
ZIPSMILE:  
ZIPSMILE:  
<pre>https://engine.tygron.com/api/session/items/popups/?f=ZIPSMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=ZIPSMILE&token=API_TOKEN&crs=3857</syntaxhighlight>
{{article end|seealso=*[[Api Content Items]]}}
==Api Model Answer==
API Model description of Answer
 
{|class=wikitable
!Name
!Type
!Description
|-
| clientEvents
| CodedEvent<nowiki>[]</nowiki>
|
|-
| contents
| String
|
|-
| events
| CodedEvent<nowiki>[]</nowiki>
|
|-
| id
| int
|
|-
| selected
| boolean
|
|}
 
==Api Model CodedEvent==
API Model description of CodedEvent
 
{|class=wikitable
!Name
!Type
!Description
|-
| id
| int
|
|-
| parameters
| Object<nowiki>[]</nowiki>
|
|}
 
==Api Model GeometryCollection==
API Model description of GeometryCollection
 
{|class=wikitable
!Name
!Type
!Description
|}
 
==Api Model MultiPolygon==
API Model description of MultiPolygon
 
{|class=wikitable
!Name
!Type
!Description
|-
| type
| String
| [[MultiPolygon]]
|-
| coordinates
| double[][][][]
| array of [[Polygon]]s; [[Polygon]] is array of outer and optional inner rings; rings is array of coordinates; coordinates is array of [x,y,(optional) z]
|}
 
==Api Model Point==
API Model description of Point
 
{|class=wikitable
!Name
!Type
!Description
|-
| type
| String
| [[Point]]
|-
| coordinates
| double[]
| x, y, (optional) z
|}
 
==Api Model PopupData==
API Model description of PopupData
 
{|class=wikitable
!Name
!Type
!Description
|-
| answers
| Answer<nowiki>[]</nowiki>
| [[Answer (Panel)]]<nowiki>[]</nowiki>
|-
| calendar
| long
|
|-
| color
| TColor
| [[Color]]
|-
| id
| int
|
|-
| imageType
| PopupImageType
| [[Popup]]ImageType
|-
| linkID
| int
|
|-
| linkType
| MapLink
| [[Maplink]]
|-
| modelDataID
| int
| [[Model Data]] ID
|-
| modelType
| PopupModelType
| [[Popup]]ModelType
|-
| name
| String
|
|-
| opensAutomatically
| boolean
|
|-
| overrideAttention
| Boolean
|
|-
| point
| Point
| [[Point]]
|-
| polygons
| MultiPolygon
| [[MultiPolygon]]
|-
| scale
| double
|
|-
| text
| String
|
|-
| title
| String
|
|-
| type
| Type
|
|-
| version
| int
|
|-
| visibleForStakeholderIDs
| int<nowiki>[]</nowiki>
| [[Stakeholder]]s ID
|-
| visibleTimeframe
| int
|
|}
 
==Api Model PopupImageType==
API Enumeration description of PopupImageType
 
{|class=wikitable
!Name
!Description
|-
| PICK_DATE
|
|-
| REQUEST_PERMIT
|
|-
| RECEIVE_REQUEST
|
|-
| WAITING
|
|-
| DECLINE
|
|-
| APPROVE
|
|-
| WAIT_BUILD
|
|-
| WAIT_DEMOLISH
|
|-
| BUILD_PROGRESS
|
|-
| DEMOLISH_PROGRESS
|
|-
| BUY_LAND
|
|-
| SELL_LAND
|
|}
 
==Api Model PopupModelType==
API Enumeration description of PopupModelType
 
{|class=wikitable
!Name
!Description
|-
| APPROVED
|
|-
| ARROW
|
|-
| BUY
|
|-
| CONNECT_ON
|
|-
| CONNECT_OFF
|
|-
| CONSTRUCTING
|
|-
| ELEVATION
|
|-
| DECLINED
|
|-
| DEMOLISHING
|
|-
| WAITING
|
|-
| QUESTION_MARK
|
|-
| TRAFFIC_NOISE
|
|-
| WATER_CRANE
|
|-
| WATER_ARROW
|
|-
| WATER_WEIR
|
|-
| LIGHT_BULB
|
|-
| LIGHTNING
|
|-
| BAR_CHART
|
|-
| EXCLAMATION
|
|}
 
==Api Model TColor==
API Model description of TColor
 
{|class=wikitable
!Name
!Type
!Description
|}
 
==Api Model Type (PopupData)==
API Enumeration description of Type
 
{|class=wikitable
!Name
!Description
|-
| STAKEHOLDER_STANDARD
|
|-
| INTERACTION
|
|-
| INTERACTION_WITH_DATE
|
|-
| INFORMATION
|
|-
| LABEL
|
|}
 
{{article end|seealso=*[[Api Content Items]]
*[[Api session event editor]]
}}


[[Category:API]]
[[Category:API]]
[[Category:Items]]

Latest revision as of 07:14, 7 July 2026

API Endpoint: /api/session/items/popups/

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

Get Queries

attributes: 

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

max version: 

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

count: 

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

Formats

HTML: 

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

JSON: 

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

GEOJSON: 

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

GPKG: 

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

DXF: 

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

CSV: 

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

SSV: 

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

SMILE: 

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

ZIPJSON: 

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

ZIPSMILE: 

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

Api Model Answer

API Model description of Answer

Name Type Description
clientEvents CodedEvent[]
contents String
events CodedEvent[]
id int
selected boolean

Api Model CodedEvent

API Model description of CodedEvent

Name Type Description
id int
parameters Object[]

Api Model GeometryCollection

API Model description of GeometryCollection

Name Type Description

Api Model MultiPolygon

API Model description of MultiPolygon

Name Type Description
type String MultiPolygon
coordinates double[][][][] array of Polygons; Polygon is array of outer and optional inner rings; rings is array of coordinates; coordinates is array of [x,y,(optional) z]

Api Model Point

API Model description of Point

Name Type Description
type String Point
coordinates double[] x, y, (optional) z

Api Model PopupData

API Model description of PopupData

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

Api Model PopupImageType

API Enumeration description of PopupImageType

Name Description
PICK_DATE
REQUEST_PERMIT
RECEIVE_REQUEST
WAITING
DECLINE
APPROVE
WAIT_BUILD
WAIT_DEMOLISH
BUILD_PROGRESS
DEMOLISH_PROGRESS
BUY_LAND
SELL_LAND

Api Model PopupModelType

API Enumeration description of PopupModelType

Name Description
APPROVED
ARROW
BUY
CONNECT_ON
CONNECT_OFF
CONSTRUCTING
ELEVATION
DECLINED
DEMOLISHING
WAITING
QUESTION_MARK
TRAFFIC_NOISE
WATER_CRANE
WATER_ARROW
WATER_WEIR
LIGHT_BULB
LIGHTNING
BAR_CHART
EXCLAMATION

Api Model TColor

API Model description of TColor

Name Type Description

Api Model Type (PopupData)

API Enumeration description of Type

Name Description
STAKEHOLDER_STANDARD
INTERACTION
INTERACTION_WITH_DATE
INFORMATION
LABEL

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_items_popups&oldid=89414"