Api session items popups: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (7 intermediate revisions by the same user not shown) | |||
| Line 83: | Line 83: | ||
==Formats== | ==Formats== | ||
HTML: | HTML: | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=HTML&token=API_TOKEN</syntaxhighlight> | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=HTML&token=API_TOKEN&crs=3857</syntaxhighlight> | ||
JSON: | JSON: | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=JSON&token=API_TOKEN</syntaxhighlight> | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=JSON&token=API_TOKEN&crs=3857</syntaxhighlight> | ||
GEOJSON: | GEOJSON: | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=GEOJSON&token=API_TOKEN</syntaxhighlight> | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=GEOJSON&token=API_TOKEN&crs=3857</syntaxhighlight> | ||
GPKG: | GPKG: | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=GPKG&token=API_TOKEN</syntaxhighlight> | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=GPKG&token=API_TOKEN&crs=3857</syntaxhighlight> | ||
DXF: | DXF: | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=DXF&token=API_TOKEN</syntaxhighlight> | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=DXF&token=API_TOKEN&crs=3857</syntaxhighlight> | ||
CSV: | CSV: | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=CSV&token=API_TOKEN</syntaxhighlight> | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=CSV&token=API_TOKEN&crs=3857</syntaxhighlight> | ||
SSV: | SSV: | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=SSV&token=API_TOKEN</syntaxhighlight> | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=SSV&token=API_TOKEN&crs=3857</syntaxhighlight> | ||
SMILE: | SMILE: | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=SMILE&token=API_TOKEN</syntaxhighlight> | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=SMILE&token=API_TOKEN&crs=3857</syntaxhighlight> | ||
ZIPJSON: | ZIPJSON: | ||
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=ZIPJSON&token=API_TOKEN</syntaxhighlight> | <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/popups/?f=ZIPJSON&token=API_TOKEN&crs=3857</syntaxhighlight> | ||
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&crs=3857</syntaxhighlight> | ||
==Api Model Answer== | ==Api Model Answer== | ||
API Model description of Answer | API Model description of Answer | ||
| Line 110: | Line 110: | ||
!Description | !Description | ||
|- | |- | ||
|clientEvents | | clientEvents | ||
|CodedEvent<nowiki>[]</nowiki> | | CodedEvent<nowiki>[]</nowiki> | ||
| | | | ||
|- | |- | ||
|contents | | contents | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|events | | events | ||
|CodedEvent<nowiki>[]</nowiki> | | CodedEvent<nowiki>[]</nowiki> | ||
| | | | ||
|- | |- | ||
|id | | id | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|selected | | selected | ||
|boolean | | boolean | ||
| | | | ||
|} | |} | ||
| Line 139: | Line 139: | ||
!Description | !Description | ||
|- | |- | ||
|id | | id | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|parameters | | parameters | ||
|Object<nowiki>[]</nowiki> | | Object<nowiki>[]</nowiki> | ||
| | | | ||
|} | |} | ||
| Line 165: | Line 165: | ||
!Description | !Description | ||
|- | |- | ||
|type | | type | ||
|String | | String | ||
|[[ | | [[MultiPolygon]] | ||
|- | |- | ||
|coordinates | | coordinates | ||
|double[][][][] | | double[][][][] | ||
|array of [[ | | 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] | ||
|} | |} | ||
| Line 182: | Line 182: | ||
!Description | !Description | ||
|- | |- | ||
|type | | type | ||
|String | | String | ||
|[[ | | [[Point]] | ||
|- | |- | ||
|coordinates | | coordinates | ||
|double[] | | double[] | ||
|x, y, (optional) z | | x, y, (optional) z | ||
|} | |} | ||
| Line 199: | Line 199: | ||
!Description | !Description | ||
|- | |- | ||
|answers | | answers | ||
|Answer<nowiki>[]</nowiki> | | Answer<nowiki>[]</nowiki> | ||
| | | [[Answer (Panel)]]<nowiki>[]</nowiki> | ||
|- | |- | ||
|calendar | | calendar | ||
|long | | long | ||
| | | | ||
|- | |- | ||
|color | | color | ||
|TColor | | TColor | ||
| | | [[Color]] | ||
|- | |- | ||
|id | | id | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|imageType | | imageType | ||
|PopupImageType | | PopupImageType | ||
| | | [[Popup]]ImageType | ||
|- | |- | ||
|linkID | | linkID | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|linkType | | linkType | ||
|MapLink | | MapLink | ||
| | | [[Maplink]] | ||
|- | |- | ||
|modelDataID | | modelDataID | ||
|int | | int | ||
|[[Model Data]] ID | | [[Model Data]] ID | ||
|- | |- | ||
|modelType | | modelType | ||
|PopupModelType | | PopupModelType | ||
| | | [[Popup]]ModelType | ||
|- | |- | ||
|name | | name | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|opensAutomatically | | opensAutomatically | ||
|boolean | | boolean | ||
| | | | ||
|- | |- | ||
|overrideAttention | | overrideAttention | ||
|Boolean | | Boolean | ||
| | | | ||
|- | |- | ||
|point | | point | ||
|Point | | Point | ||
| | | [[Point]] | ||
|- | |- | ||
|polygons | | polygons | ||
|MultiPolygon | | MultiPolygon | ||
| | | [[MultiPolygon]] | ||
|- | |- | ||
|scale | | scale | ||
|double | | double | ||
| | | | ||
|- | |- | ||
|text | | text | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|title | | title | ||
|String | | String | ||
| | | | ||
|- | |- | ||
|type | | type | ||
|Type | | Type | ||
| | | | ||
|- | |- | ||
|version | | version | ||
|int | | int | ||
| | | | ||
|- | |- | ||
|visibleForStakeholderIDs | | visibleForStakeholderIDs | ||
|int<nowiki>[]</nowiki> | | int<nowiki>[]</nowiki> | ||
|[[Stakeholder]]s ID | | [[Stakeholder]]s ID | ||
|- | |- | ||
|visibleTimeframe | | visibleTimeframe | ||
|int | | int | ||
| | | | ||
|} | |} | ||
| Line 291: | Line 291: | ||
!Description | !Description | ||
|- | |- | ||
|PICK_DATE | | PICK_DATE | ||
| | | | ||
|- | |- | ||
|REQUEST_PERMIT | | REQUEST_PERMIT | ||
| | | | ||
|- | |- | ||
|RECEIVE_REQUEST | | RECEIVE_REQUEST | ||
| | | | ||
|- | |- | ||
|WAITING | | WAITING | ||
| | | | ||
|- | |- | ||
|DECLINE | | DECLINE | ||
| | | | ||
|- | |- | ||
|APPROVE | | APPROVE | ||
| | | | ||
|- | |- | ||
|WAIT_BUILD | | WAIT_BUILD | ||
| | | | ||
|- | |- | ||
|WAIT_DEMOLISH | | WAIT_DEMOLISH | ||
| | | | ||
|- | |- | ||
|BUILD_PROGRESS | | BUILD_PROGRESS | ||
| | | | ||
|- | |- | ||
|DEMOLISH_PROGRESS | | DEMOLISH_PROGRESS | ||
| | | | ||
|- | |- | ||
|BUY_LAND | | BUY_LAND | ||
| | | | ||
|- | |- | ||
|SELL_LAND | | SELL_LAND | ||
| | | | ||
|} | |} | ||
| Line 335: | Line 335: | ||
!Description | !Description | ||
|- | |- | ||
|APPROVED | | APPROVED | ||
| | | | ||
|- | |- | ||
|ARROW | | ARROW | ||
| | | | ||
|- | |- | ||
|BUY | | BUY | ||
| | | | ||
|- | |- | ||
|CONNECT_ON | | CONNECT_ON | ||
| | | | ||
|- | |- | ||
|CONNECT_OFF | | CONNECT_OFF | ||
| | | | ||
|- | |- | ||
|CONSTRUCTING | | CONSTRUCTING | ||
| | | | ||
|- | |- | ||
|ELEVATION | | ELEVATION | ||
| | | | ||
|- | |- | ||
|DECLINED | | DECLINED | ||
| | | | ||
|- | |- | ||
|DEMOLISHING | | DEMOLISHING | ||
| | | | ||
|- | |- | ||
|WAITING | | WAITING | ||
| | | | ||
|- | |- | ||
|QUESTION_MARK | | QUESTION_MARK | ||
| | | | ||
|- | |- | ||
|TRAFFIC_NOISE | | TRAFFIC_NOISE | ||
| | | | ||
|- | |- | ||
|WATER_CRANE | | WATER_CRANE | ||
| | | | ||
|- | |- | ||
|WATER_ARROW | | WATER_ARROW | ||
| | | | ||
|- | |- | ||
|WATER_WEIR | | WATER_WEIR | ||
| | | | ||
|- | |- | ||
|LIGHT_BULB | | LIGHT_BULB | ||
| | | | ||
|- | |- | ||
|LIGHTNING | | LIGHTNING | ||
| | | | ||
|- | |- | ||
|BAR_CHART | | BAR_CHART | ||
| | | | ||
|- | |- | ||
|EXCLAMATION | | EXCLAMATION | ||
| | | | ||
|} | |} | ||
| Line 409: | Line 409: | ||
!Description | !Description | ||
|- | |- | ||
|STAKEHOLDER_STANDARD | | STAKEHOLDER_STANDARD | ||
| | | | ||
|- | |- | ||
|INTERACTION | | INTERACTION | ||
| | | | ||
|- | |- | ||
|INTERACTION_WITH_DATE | | INTERACTION_WITH_DATE | ||
| | | | ||
|- | |- | ||
|INFORMATION | | INFORMATION | ||
| | | | ||
|- | |- | ||
|LABEL | | LABEL | ||
| | | | ||
|} | |} | ||
Latest revision as of 13:04, 19 June 2026
API Endpoint: /api/session/items/popups/
Default Query:
https://engine.tygron.com/api/session/items/popups/?f=JSON&token=API_TOKENExample 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_TOKENPseudo-Mercator:
https://engine.tygron.com/api/session/items/popups/?crs=3857&token=API_TOKENDegrees:
https://engine.tygron.com/api/session/items/popups/?crs=4326&token=API_TOKENAmersfoort / RD New:
https://engine.tygron.com/api/session/items/popups/?crs=28992&token=API_TOKENLocal Coordinates:
https://engine.tygron.com/api/session/items/popups/?crs=LOCAL&token=API_TOKENbbox=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_TOKENFOO:
https://engine.tygron.com/api/session/items/popups-foo/?crs=3857&token=API_TOKENShow Queries
max version:
https://engine.tygron.com/api/session/items/popups/version/?token=API_TOKENsize:
https://engine.tygron.com/api/session/items/popups/size/?token=API_TOKENPopups (GeoJSON):
https://engine.tygron.com/web/popups.geojson?crs=3857&bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785&token=API_TOKENFormats
HTML:
https://engine.tygron.com/api/session/items/popups/?f=HTML&token=API_TOKEN&crs=3857JSON:
https://engine.tygron.com/api/session/items/popups/?f=JSON&token=API_TOKEN&crs=3857GEOJSON:
https://engine.tygron.com/api/session/items/popups/?f=GEOJSON&token=API_TOKEN&crs=3857GPKG:
https://engine.tygron.com/api/session/items/popups/?f=GPKG&token=API_TOKEN&crs=3857DXF:
https://engine.tygron.com/api/session/items/popups/?f=DXF&token=API_TOKEN&crs=3857CSV:
https://engine.tygron.com/api/session/items/popups/?f=CSV&token=API_TOKEN&crs=3857SSV:
https://engine.tygron.com/api/session/items/popups/?f=SSV&token=API_TOKEN&crs=3857SMILE:
https://engine.tygron.com/api/session/items/popups/?f=SMILE&token=API_TOKEN&crs=3857ZIPJSON:
https://engine.tygron.com/api/session/items/popups/?f=ZIPJSON&token=API_TOKEN&crs=3857ZIPSMILE:
https://engine.tygron.com/api/session/items/popups/?f=ZIPSMILE&token=API_TOKEN&crs=3857Api 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 |