Api session items netlines: 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
Replaced content with "Api session items Net Lines Endpoints. Edit items with event: editornetline. Default Query: <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netlines/?f=JSON&token=API_TOKEN</syntaxhighlight> Example Response: <syntaxhighlight lang="text" copy>[ { "attributes" : null, "endNodeID" : 1, "functionID" : 0, "id" : 0, "maquetteOverride" : null, "name" : "NetLine 0", "sourceIDs" : [ ], "..."
Tag: Replaced
No edit summary
 
(28 intermediate revisions by the same user not shown)
Line 1: Line 1:
Api session items [[Net Line]]s Endpoints.
API Endpoint: /api/session/items/netlines/


Edit items with event: [[Api session event editor netline|editornetline]].
Edit items with events described at [[Api session event editor netline]].


Default Query:
Default Query:
Line 15: Line 15:
   "sourceIDs" : [ ],
   "sourceIDs" : [ ],
   "startNodeID" : 0,
   "startNodeID" : 0,
   "version" : 11
   "version" : 31
}, {
}, {
   "attributes" : null,
   "attributes" : null,
Line 25: Line 25:
   "sourceIDs" : [ ],
   "sourceIDs" : [ ],
   "startNodeID" : 35,
   "startNodeID" : 35,
   "version" : 12
   "version" : 32
} ]</syntaxhighlight>
} ]</syntaxhighlight>
==Limit Queries==
==Limit Queries==
Line 42: Line 42:
FOO:  
FOO:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/net_lines-foo/?crs=3857&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/net_lines-foo/?crs=3857&token=API_TOKEN</syntaxhighlight>
==Show Queries==
==Get Queries==
attributes:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netlines/attributes/?token=API_TOKEN</syntaxhighlight>
max version:  
max version:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netlines/version/?token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netlines/version/?token=API_TOKEN</syntaxhighlight>
size:  
count:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netlines/size/?token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netlines/count/?token=API_TOKEN</syntaxhighlight>
Net Lines (GeoJSON):
<syntaxhighlight lang="text" copy>https://engine.tygron.com/web/lines.geojson?token=API_TOKEN</syntaxhighlight>
==Formats==
==Formats==
HTML:  
HTML:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netlines/?f=HTML&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netlines/?f=HTML&token=API_TOKEN&crs=3857</syntaxhighlight>
JSON:  
JSON:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netlines/?f=JSON&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netlines/?f=JSON&token=API_TOKEN&crs=3857</syntaxhighlight>
GEOJSON:  
GEOJSON:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netlines/?f=GEOJSON&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netlines/?f=GEOJSON&token=API_TOKEN&crs=3857</syntaxhighlight>
GPKG:  
GPKG:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netlines/?f=GPKG&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netlines/?f=GPKG&token=API_TOKEN&crs=3857</syntaxhighlight>
DXF:  
DXF:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netlines/?f=DXF&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netlines/?f=DXF&token=API_TOKEN&crs=3857</syntaxhighlight>
CSV:  
CSV:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netlines/?f=CSV&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netlines/?f=CSV&token=API_TOKEN&crs=3857</syntaxhighlight>
SSV:  
SSV:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netlines/?f=SSV&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netlines/?f=SSV&token=API_TOKEN&crs=3857</syntaxhighlight>
SMILE:  
SMILE:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netlines/?f=SMILE&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netlines/?f=SMILE&token=API_TOKEN&crs=3857</syntaxhighlight>
ZIPJSON:  
ZIPJSON:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netlines/?f=ZIPJSON&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netlines/?f=ZIPJSON&token=API_TOKEN&crs=3857</syntaxhighlight>
ZIPSMILE:  
ZIPSMILE:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netlines/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netlines/?f=ZIPSMILE&token=API_TOKEN&crs=3857</syntaxhighlight>
==Api Model LoadAttribute==
API Enumeration description of LoadAttribute
 
{|class=wikitable
!Name
!Description
|-
|CONNECTION_COST
|
|-
|FLOW
|
|-
|POWER
|
|-
|CONNECTION_COUNT
|
|-
|FLOOR_SPACE_M2
|
|-
|TYPE
|
|-
|ROOT_LOAD
|
|-
|LOAD_COUNT
|
|-
|ADDRESS_COUNT
|
|-
|CONNECTION_FRACTION
|
|-
|PRESSURE_M_H2O_SUPPLY
|
|-
|PRESSURE_M_H2O_RETURN
|
|-
|TEMPERATURE_SUPPLY_DEGREES_CELSIUS
|
|}
 
==Api Model LoadCostSegment==
API Model description of LoadCostSegment
 
{|class=wikitable
!Name
!Type
!Description
|-
|baseCost
|double
|
|-
|incrCost
|double
|
|-
|minValue
|int
|
|}
 
==Api Model LoadParameterType==
API Enumeration description of LoadParameterType
 
{|class=wikitable
!Name
!Description
|-
|FLOW
|
|-
|POWER
|
|-
|CONNECTION_COST
|
|-
|CONNECTION
|
|-
|FLOOR_SPACE_M2
|
|}
 
==Api Model LoadType==
API Enumeration description of LoadType
 
{|class=wikitable
!Name
!Description
|-
|UNKNOWN
|
|-
|COLLECTIVE
|
|-
|COLLECTIVE_TAP
|
|-
|COLLECTIVE_RADIATOR
|
|-
|COLLECTIVE_RADIATOR_TAP
|
|-
|INDIVIDUAL
|
|-
|LARGE_SCALE_CONSUMER
|
|}
 
==Api Model NetFunction==
API Model description of NetFunction
 
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|diameterM
|double
|
|-
|groupName
|String
|
|-
|id
|int
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|netType
|NetType
|
|-
|priceM
|double
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|version
|int
|
|}
 
==Api Model NetLine==
==Api Model NetLine==
API Model description of NetLine
API Model description of NetLine
Line 247: Line 78:
!Description
!Description
|-
|-
|attributes
| attributes
|Map&lt;String,double[]&gt;
| Map&lt;String,double[]&gt;
|
|  
|-
|endNodeID
|int
|[[Net Node]] ID
|-
|functionID
|int
|[[Net Function]] ID
|-
|id
|int
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|startNodeID
|int
|[[Net Node]] ID
|-
|version
|int
|
|}
 
==Api Model NetLineAttribute==
API Enumeration description of NetLineAttribute
 
{|class=wikitable
!Name
!Description
|-
|FLOW
|
|-
|DIAMETER_M
|
|-
|ALWAYS_ACTIVE
|
|}
 
==Api Model NetLineFunctionAttribute==
API Enumeration description of NetLineFunctionAttribute
 
{|class=wikitable
!Name
!Description
|-
|PRICE_M
|
|-
|VISUALIZATION_DIAMETER_M
|
|-
|DIAMETER_M
|
|-
|COLOR
|
|}
 
==Api Model NetLoad==
API Model description of NetLoad
 
{|class=wikitable
!Name
!Type
!Description
|-
|addressIDs
|int<nowiki>[]</nowiki>
|[[Address]] ID
|-
|-
|attributes
| endNodeID
|Map&lt;String,double[]&gt;
| int
|
| [[Net Node]] ID
|-
|-
|buildingID
| functionID
|int
| int
|[[Building]] ID  
| [[Net Function]] ID  
|-
|-
|clusterID
| id
|int
| int
|[[Net Cluster]] ID
|  
|-
|connectionState
|TimeState
|
|-
|id
|int
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|netType
|NetType
|
|-
|nodeID
|int
|[[Net Node]] ID
|-
|point
|Point
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|version
|int
|
|}
 
==Api Model NetOverlay==
API Model description of NetOverlay
 
{|class=wikitable
!Name
!Type
!Description
|-
|attributes
|Map&lt;String,double[]&gt;
|
|-
|colorMultiplier
|double
|
|-
|colorOffset
|int
|
|-
|customLegend
|boolean
|
|-
|id
|int
|
|-
|imageName
|String
|
|-
|imageVersion
|int
|
|-
|legend
|LegendEntry<nowiki>[]</nowiki>
|
|-
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|-
|name
|String
|
|-
|netType
|NetType
|
|-
|parentID
|int
|[[Overlay]] ID
|-
|showActive
|boolean
|
|-
|showNetwork
|boolean
|
|-
|sortIndex
|int
|
|-
|type
|OverlayType
|
|-
|version
|int
|
|-
|visible
|boolean
|
|}
 
==Api Model NetType==
API Enumeration description of NetType
 
{|class=wikitable
!Name
!Description
|-
|-
|ELECTRICITY
| maquetteOverride
|
| Map&lt;String,double[]&gt;
|  
|-
|-
|GAS
| name
|
| String
|  
|-
|-
|HEAT
| sourceIDs
|
| int<nowiki>[]</nowiki>
| [[Source]]s ID
|-
|-
|INTERNET
| startNodeID
|
| int
| [[Net Node]] ID
|-
|-
|SEWER
| version
|
| int
|  
|}
|}


Line 491: Line 120:


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

Latest revision as of 07:06, 14 July 2026

API Endpoint: /api/session/items/netlines/

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

Default Query: 

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

Example Response: 

[ {
  "attributes" : null,
  "endNodeID" : 1,
  "functionID" : 0,
  "id" : 0,
  "maquetteOverride" : null,
  "name" : "NetLine 0",
  "sourceIDs" : [ ],
  "startNodeID" : 0,
  "version" : 31
}, {
  "attributes" : null,
  "endNodeID" : 58,
  "functionID" : 0,
  "id" : 1,
  "maquetteOverride" : null,
  "name" : "NetLine 1",
  "sourceIDs" : [ ],
  "startNodeID" : 35,
  "version" : 32
} ]

Limit Queries

version=100: 

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

Pseudo-Mercator: 

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

Degrees: 

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

Amersfoort / RD New: 

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

Local Coordinates: 

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

bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785: 

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

FOO: 

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

Get Queries

attributes: 

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

max version: 

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

count: 

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

Formats

HTML: 

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

JSON: 

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

GEOJSON: 

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

GPKG: 

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

DXF: 

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

CSV: 

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

SSV: 

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

SMILE: 

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

ZIPJSON: 

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

ZIPSMILE: 

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

Api Model NetLine

API Model description of NetLine

Name Type Description
attributes Map<String,double[]>
endNodeID int Net Node ID
functionID int Net Function ID
id int
maquetteOverride Map<String,double[]>
name String
sourceIDs int[] Sources ID
startNodeID int Net Node ID
version int

See also

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