Api session items panels: 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
51,321 edits
No edit summary
No edit summary
 
(32 intermediate revisions by the same user not shown)
Line 4: Line 4:


Default Query:
Default Query:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/panels/?f=JSON&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/panels/?token=API_TOKEN</syntaxhighlight>
Example Response:
Example Response:
<syntaxhighlight lang="text" copy>[ {
<syntaxhighlight lang="text" copy>[ {
Line 34: Line 34:
   "type" : "EXCEL_PANEL",
   "type" : "EXCEL_PANEL",
   "updateTiming" : "BEFORE",
   "updateTiming" : "BEFORE",
   "version" : 6,
   "version" : 1,
   "warnings" : "",
   "warnings" : "",
   "width" : null
   "width" : null
Line 64: Line 64:
   },
   },
   "stakeholderID" : -1,
   "stakeholderID" : -1,
   "text" : "Point of interest",
   "text" : "$SELECT_TOKEN_WHERE",
   "type" : "TEXT_PANEL",
   "type" : "TEXT_PANEL",
   "updateTiming" : "BEFORE",
   "updateTiming" : "BEFORE",
   "version" : 1,
   "version" : 2,
   "warnings" : "",
   "warnings" : "WARNING: API Token may be exposed! in query: SELECT_TOKEN_WHERE",
   "width" : null
   "width" : null
} ]</syntaxhighlight>
} ]</syntaxhighlight>
==Limit Queries==
==Limit Queries==
version=100:  
Version=100:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/panels/?version=100&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/panels/?version=100&token=API_TOKEN</syntaxhighlight>
==Show Queries==
==Get Queries==
max version:  
Attributes:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/panels/attributes/?token=API_TOKEN</syntaxhighlight>
Max version:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/panels/version/?token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/panels/version/?token=API_TOKEN</syntaxhighlight>
size:  
Count:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/panels/size/?token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/panels/count/?token=API_TOKEN</syntaxhighlight>
Specific Item by ID:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/panels/{id}/?token=API_TOKEN</syntaxhighlight>
==Formats==
==Formats==
HTML:  
HTML:  
Line 150: Line 154:
| answers
| answers
| Answer<nowiki>[]</nowiki>
| Answer<nowiki>[]</nowiki>
| [[Answer (Panel)]]<nowiki>[]</nowiki>
| [[Answer (Panel)|Answer]]<nowiki>[]</nowiki>
|-
|-
| attributes
| attributes
Line 170: Line 174:
| excelID
| excelID
| int
| int
| [[[[Excel Sheet]]]] ID  
| [[Excel Sheet]] ID  
|-
|-
| height
| height
Line 198: Line 202:
| overlayID
| overlayID
| int
| int
| [[[[Overlay]]]] ID  
| [[Overlay]] ID  
|-
|-
| overrideDefaultAnswerID
| overrideDefaultAnswerID
Line 210: Line 214:
| point
| point
| Point
| Point
| [[#Api Model Point|Point]]
| [[Point]]
|-
|-
| polygons
| polygons
| MultiPolygon
| MultiPolygon
| [[#Api Model MultiPolygon|MultiPolygon]]
| [[MultiPolygon]]
|-
|-
| stakeholderID
| stakeholderID
| int
| int
| [[[[Stakeholder]]]] ID  
| [[Stakeholder]] ID  
|-
|-
| text
| text
Line 264: Line 268:
| answers
| answers
| Answer<nowiki>[]</nowiki>
| Answer<nowiki>[]</nowiki>
| [[Answer (Panel)]]<nowiki>[]</nowiki>
| [[Answer (Panel)|Answer]]<nowiki>[]</nowiki>
|-
|-
| attributes
| attributes
Line 272: Line 276:
| globalIDs
| globalIDs
| int<nowiki>[]</nowiki>
| int<nowiki>[]</nowiki>
| [[[[Global]]]]s ID  
| [[Global]]s ID  
|-
|-
| height
| height
Line 300: Line 304:
| overlayID
| overlayID
| int
| int
| [[[[Overlay]]]] ID  
| [[Overlay]] ID  
|-
|-
| overrideDefaultAnswerID
| overrideDefaultAnswerID
Line 308: Line 312:
| point
| point
| Point
| Point
| [[#Api Model Point|Point]]
| [[Point]]
|-
|-
| stakeholderID
| stakeholderID
| int
| int
| [[[[Stakeholder]]]] ID  
| [[Stakeholder]] ID  
|-
|-
| type
| type
Line 337: Line 341:
| answers
| answers
| Answer<nowiki>[]</nowiki>
| Answer<nowiki>[]</nowiki>
| [[Answer (Panel)]]<nowiki>[]</nowiki>
| [[Answer (Panel)|Answer]]<nowiki>[]</nowiki>
|-
|-
| attributes
| attributes
Line 381: Line 385:
| overlayID
| overlayID
| int
| int
| [[[[Overlay]]]] ID  
| [[Overlay]] ID  
|-
|-
| overrideDefaultAnswerID
| overrideDefaultAnswerID
Line 393: Line 397:
| point
| point
| Point
| Point
| [[#Api Model Point|Point]]
| [[Point]]
|-
|-
| stakeholderID
| stakeholderID
| int
| int
| [[[[Stakeholder]]]] ID  
| [[Stakeholder]] ID  
|-
|-
| text
| text
Line 434: Line 438:
| type
| type
| String
| String
| [[#Api Model [[#Api Model MultiPolygon|MultiPolygon]]|[[#Api Model MultiPolygon|MultiPolygon]]]]
| [[MultiPolygon]]
|-
|-
| coordinates
| coordinates
| double[][][][]
| double[][][][]
| array of [[#Api Model [[#Api Model Polygon|Polygon]]|[[#Api Model Polygon|Polygon]]]]s; [[#Api Model [[#Api Model Polygon|Polygon]]|[[#Api Model Polygon|Polygon]]]] is array of outer and optional inner rings; rings is array of coordinates; coordinates is array of [x,y,(optional) z]
| 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 451: Line 455:
| answers
| answers
| Answer<nowiki>[]</nowiki>
| Answer<nowiki>[]</nowiki>
| [[Answer (Panel)]]<nowiki>[]</nowiki>
| [[Answer (Panel)|Answer]]<nowiki>[]</nowiki>
|-
|-
| attributes
| attributes
Line 483: Line 487:
| overlayID
| overlayID
| int
| int
| [[[[Overlay]]]] ID  
| [[Overlay]] ID  
|-
|-
| overrideDefaultAnswerID
| overrideDefaultAnswerID
Line 491: Line 495:
| point
| point
| Point
| Point
| [[#Api Model Point|Point]]
| [[Point]]
|-
|-
| stakeholderID
| stakeholderID
| int
| int
| [[[[Stakeholder]]]] ID  
| [[Stakeholder]] ID  
|-
|-
| type
| type
Line 546: Line 550:
| type
| type
| String
| String
| [[#Api Model [[#Api Model Point|Point]]|[[#Api Model Point|Point]]]]
| [[Point]]
|-
|-
| coordinates
| coordinates
Line 613: Line 617:
| answers
| answers
| Answer<nowiki>[]</nowiki>
| Answer<nowiki>[]</nowiki>
| [[Answer (Panel)]]<nowiki>[]</nowiki>
| [[Answer (Panel)|Answer]]<nowiki>[]</nowiki>
|-
|-
| attribute
| attribute
Line 641: Line 645:
| excelID
| excelID
| int
| int
| [[[[Excel Sheet]]]] ID  
| [[Excel Sheet]] ID  
|-
|-
| height
| height
Line 673: Line 677:
| overlayID
| overlayID
| int
| int
| [[[[Overlay]]]] ID  
| [[Overlay]] ID  
|-
|-
| overrideDefaultAnswerID
| overrideDefaultAnswerID
Line 685: Line 689:
| point
| point
| Point
| Point
| [[#Api Model Point|Point]]
| [[Point]]
|-
|-
| polygons
| polygons
| MultiPolygon
| MultiPolygon
| [[#Api Model MultiPolygon|MultiPolygon]]
| [[MultiPolygon]]
|-
|-
| relation
| relation
Line 697: Line 701:
| stakeholderID
| stakeholderID
| int
| int
| [[[[Stakeholder]]]] ID  
| [[Stakeholder]] ID  
|-
|-
| text
| text
Line 738: Line 742:
| answers
| answers
| Answer<nowiki>[]</nowiki>
| Answer<nowiki>[]</nowiki>
| [[Answer (Panel)]]<nowiki>[]</nowiki>
| [[Answer (Panel)|Answer]]<nowiki>[]</nowiki>
|-
|-
| attribute
| attribute
Line 794: Line 798:
| overlayID
| overlayID
| int
| int
| [[[[Overlay]]]] ID  
| [[Overlay]] ID  
|-
|-
| overrideDefaultAnswerID
| overrideDefaultAnswerID
Line 806: Line 810:
| point
| point
| Point
| Point
| [[#Api Model Point|Point]]
| [[Point]]
|-
|-
| relation
| relation
Line 814: Line 818:
| stakeholderID
| stakeholderID
| int
| int
| [[[[Stakeholder]]]] ID  
| [[Stakeholder]] ID  
|-
|-
| text
| text
Line 855: Line 859:
| answers
| answers
| Answer<nowiki>[]</nowiki>
| Answer<nowiki>[]</nowiki>
| [[Answer (Panel)]]<nowiki>[]</nowiki>
| [[Answer (Panel)|Answer]]<nowiki>[]</nowiki>
|-
|-
| attributes
| attributes
Line 899: Line 903:
| overlayID
| overlayID
| int
| int
| [[[[Overlay]]]] ID  
| [[Overlay]] ID  
|-
|-
| overrideDefaultAnswerID
| overrideDefaultAnswerID
Line 911: Line 915:
| point
| point
| Point
| Point
| [[#Api Model Point|Point]]
| [[Point]]
|-
|-
| stakeholderID
| stakeholderID
| int
| int
| [[[[Stakeholder]]]] ID  
| [[Stakeholder]] ID  
|-
|-
| text
| text
Line 966: Line 970:
| answers
| answers
| Answer<nowiki>[]</nowiki>
| Answer<nowiki>[]</nowiki>
| [[Answer (Panel)]]<nowiki>[]</nowiki>
| [[Answer (Panel)|Answer]]<nowiki>[]</nowiki>
|-
|-
| attributes
| attributes
Line 998: Line 1,002:
| overlayID
| overlayID
| int
| int
| [[[[Overlay]]]] ID  
| [[Overlay]] ID  
|-
|-
| overrideDefaultAnswerID
| overrideDefaultAnswerID
Line 1,006: Line 1,010:
| point
| point
| Point
| Point
| [[#Api Model Point|Point]]
| [[Point]]
|-
|-
| stakeholderID
| stakeholderID
| int
| int
| [[[[Stakeholder]]]] ID  
| [[Stakeholder]] ID  
|-
|-
| type
| type

Latest revision as of 10:20, 13 November 2026

API Endpoint: /api/session/items/panels/

Edit items with events described at Api session event editor panel.

Default Query: 

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

Example Response: 

[ {
  "answers" : [ ],
  "attributes" : {
    "ATTENTION" : [ 1.0 ],
    "POPUP_TYPE" : [ 0.0 ],
    "SCALE" : [ 1.0 ],
    "VISIBLE" : [ 1.0 ],
    "VISIBLE_TIMEFRAME" : [ 0.0 ]
  },
  "calcTimeMS" : 0,
  "contentID" : null,
  "contentMapLink" : null,
  "excelID" : 1,
  "height" : null,
  "id" : 0,
  "layoutX" : null,
  "layoutY" : null,
  "maquetteOverride" : null,
  "name" : "Excel Panel",
  "overlayID" : -1,
  "overrideDefaultAnswerID" : -1,
  "parentID" : null,
  "point" : null,
  "polygons" : null,
  "stakeholderID" : -1,
  "text" : "Hello World!",
  "type" : "EXCEL_PANEL",
  "updateTiming" : "BEFORE",
  "version" : 1,
  "warnings" : "",
  "width" : null
}, {
  "answers" : [ ],
  "attributes" : {
    "ATTENTION" : [ 1.0 ],
    "COLOR" : [ -6704129.0 ],
    "POPUP_TYPE" : [ 7.0 ],
    "SCALE" : [ 1.0 ],
    "VISIBLE" : [ 1.0 ],
    "VISIBLE_TIMEFRAME" : [ 0.0 ]
  },
  "calcTimeMS" : 0,
  "contentID" : null,
  "contentMapLink" : null,
  "height" : null,
  "id" : 1,
  "layoutX" : null,
  "layoutY" : null,
  "maquetteOverride" : null,
  "name" : "Text Panel",
  "overlayID" : -1,
  "overrideDefaultAnswerID" : -1,
  "parentID" : null,
  "point" : {
    "type" : "Point",
    "coordinates" : [ 658907.9990757483, 6798948.801026824 ]
  },
  "stakeholderID" : -1,
  "text" : "$SELECT_TOKEN_WHERE",
  "type" : "TEXT_PANEL",
  "updateTiming" : "BEFORE",
  "version" : 2,
  "warnings" : "WARNING: API Token may be exposed! in query: SELECT_TOKEN_WHERE",
  "width" : null
} ]

Limit Queries

Version=100: 

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

Get Queries

Attributes: 

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

Max version: 

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

Count: 

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

Specific Item by ID: 

https://engine.tygron.com/api/session/items/panels/{id}/?token=API_TOKEN

Formats

HTML: 

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

JSON: 

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

CSV: 

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

SSV: 

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

SMILE: 

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

ZIPJSON: 

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

ZIPSMILE: 

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

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 ExcelPanel

API Model description of ExcelPanel

Name Type Description
answers Answer[] Answer[]
attributes Map<String,double[]>
calcTimeMS long
contentID int
contentMapLink MapLink Maplink
excelID int Excel Sheet ID
height double
id int
layoutX double
layoutY double
maquetteOverride Map<String,double[]>
name String
overlayID int Overlay ID
overrideDefaultAnswerID int
parentID int
point Point Point
polygons MultiPolygon MultiPolygon
stakeholderID int Stakeholder ID
text String
type PanelType PanelType
updateTiming Timing
version int
warnings String
width double

Api Model GeometryCollection

API Model description of GeometryCollection

Name Type Description

Api Model GlobalPanel

API Model description of GlobalPanel

Name Type Description
answers Answer[] Answer[]
attributes Map<String,double[]>
globalIDs int[] Globals ID
height double
id int
layoutX double
layoutY double
maquetteOverride Map<String,double[]>
name String
overlayID int Overlay ID
overrideDefaultAnswerID int
point Point Point
stakeholderID int Stakeholder ID
type PanelType PanelType
version int
width double

Api Model LogicPanel

API Model description of LogicPanel

Name Type Description
answers Answer[] Answer[]
attributes Map<String,double[]>
calcTimeMS long
contentID int
contentMapLink MapLink Maplink
height double
id int
layoutX double
layoutY double
maquetteOverride Map<String,double[]>
name String
overlayID int Overlay ID
overrideDefaultAnswerID int
parentID int
point Point Point
stakeholderID int Stakeholder ID
text String
type PanelType PanelType
updateTiming Timing
version int
warnings String
width double

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 Panel

API Model description of Panel

Name Type Description
answers Answer[] Answer[]
attributes Map<String,double[]>
height double
id int
layoutX double
layoutY double
maquetteOverride Map<String,double[]>
name String
overlayID int Overlay ID
overrideDefaultAnswerID int
point Point Point
stakeholderID int Stakeholder ID
type PanelType PanelType
version int
width double

Api Model PanelType

API Enumeration description of PanelType

Name Description
GLOBAL_PANEL
EXCEL_PANEL
WEB_PANEL
TEXT_PANEL
TEMPLATE_EXCEL_PANEL
TEMPLATE_TEXT_PANEL

Api Model Point

API Model description of Point

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

Api Model Relation

API Enumeration description of Relation

Name Description
OWNER
CONSTRUCTOR
DEMOLISHER
PERMITTER
SENDER
RECEIVER
NETOWNER
BORDER_A
BORDER_B
BUILDING
WEATHER
PARENT
RESULT_PARENT
CONTENT

Api Model TemplateExcelPanel

API Model description of TemplateExcelPanel

Name Type Description
answers Answer[] Answer[]
attribute String
attributes Map<String,double[]>
autoApplied boolean
calcTimeMS long
contentID int
contentMapLink MapLink Maplink
excelID int Excel Sheet ID
height double
id int
layoutX double
layoutY double
mapLink MapLink Maplink
maquetteOverride Map<String,double[]>
name String
overlayID int Overlay ID
overrideDefaultAnswerID int
parentID int
point Point Point
polygons MultiPolygon MultiPolygon
relation Relation Relation
stakeholderID int Stakeholder ID
text String
type PanelType PanelType
updateTiming Timing
useOwner boolean
version int
warnings String
width double

Api Model TemplateTextPanel

API Model description of TemplateTextPanel

Name Type Description
answers Answer[] Answer[]
attribute String
attributes Map<String,double[]>
autoApplied boolean
calcTimeMS long
contentID int
contentMapLink MapLink Maplink
height double
id int
layoutX double
layoutY double
mapLink MapLink Maplink
maquetteOverride Map<String,double[]>
name String
overlayID int Overlay ID
overrideDefaultAnswerID int
parentID int
point Point Point
relation Relation Relation
stakeholderID int Stakeholder ID
text String
type PanelType PanelType
updateTiming Timing
useOwner boolean
version int
warnings String
width double

Api Model TextPanel

API Model description of TextPanel

Name Type Description
answers Answer[] Answer[]
attributes Map<String,double[]>
calcTimeMS long
contentID int
contentMapLink MapLink Maplink
height double
id int
layoutX double
layoutY double
maquetteOverride Map<String,double[]>
name String
overlayID int Overlay ID
overrideDefaultAnswerID int
parentID int
point Point Point
stakeholderID int Stakeholder ID
text String
type PanelType PanelType
updateTiming Timing
version int
warnings String
width double

Api Model Timing

API Enumeration description of Timing

Name Description
BEFORE
AFTER

Api Model WebPanel

API Model description of WebPanel

Name Type Description
answers Answer[] Answer[]
attributes Map<String,double[]>
height double
id int
layoutX double
layoutY double
maquetteOverride Map<String,double[]>
name String
overlayID int Overlay ID
overrideDefaultAnswerID int
point Point Point
stakeholderID int Stakeholder ID
type PanelType PanelType
url String
version int
width double

See also

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