Api session items netloads: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older editNewer edit →
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Interface administrators, Administrators
34,718 edits
Replaced content with "Api session items Net Loads Endpoints. Edit items with event: editornetload. Default Query: <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netloads/?f=JSON&token=API_TOKEN</syntaxhighlight> Example Response: <syntaxhighlight lang="text" copy>[ { "addressIDs" : [ ], "attributes" : { "ROOT_LOAD" : [ 1.0 ] }, "buildingID" : -1, "clusterID" : -1, "connectionState" : "NOTHING", "id..."
Tag: Replaced
No edit summary
Line 21: Line 21:
   "point" : null,
   "point" : null,
   "sourceIDs" : [ ],
   "sourceIDs" : [ ],
   "version" : 11
   "version" : 156
}, {
}, {
   "addressIDs" : [ 90 ],
   "addressIDs" : [ 90 ],
Line 37: Line 37:
   "point" : null,
   "point" : null,
   "sourceIDs" : [ 12 ],
   "sourceIDs" : [ 12 ],
   "version" : 12
   "version" : 157
} ]</syntaxhighlight>
} ]</syntaxhighlight>
==Limit Queries==
==Limit Queries==
Line 80: Line 80:
ZIPSMILE:  
ZIPSMILE:  
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netloads/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netloads/?f=ZIPSMILE&token=API_TOKEN</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 NetLoad==
==Api Model NetLoad==
API Model description of NetLoad
API Model description of NetLoad

Revision as of 13:28, 20 April 2026

Api session items Net Loads Endpoints.

Edit items with event: editornetload.

Default Query: 

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

Example Response: 

[ {
  "addressIDs" : [ ],
  "attributes" : {
    "ROOT_LOAD" : [ 1.0 ]
  },
  "buildingID" : -1,
  "clusterID" : -1,
  "connectionState" : "NOTHING",
  "id" : 0,
  "maquetteOverride" : null,
  "name" : "NetLoad 0",
  "netType" : "ELECTRICITY",
  "nodeID" : 0,
  "point" : null,
  "sourceIDs" : [ ],
  "version" : 156
}, {
  "addressIDs" : [ 90 ],
  "attributes" : {
    "TYPE" : [ 5.0 ]
  },
  "buildingID" : 444,
  "clusterID" : 0,
  "connectionState" : "NOTHING",
  "id" : 1,
  "maquetteOverride" : null,
  "name" : "NetLoad 1",
  "netType" : "ELECTRICITY",
  "nodeID" : 2,
  "point" : null,
  "sourceIDs" : [ 12 ],
  "version" : 157
} ]

Limit Queries

version=100: 

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

Pseudo-Mercator: 

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

Degrees: 

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

Amersfoort / RD New: 

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

Local Coordinates: 

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

bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785: 

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

FOO: 

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

Show Queries

max version: 

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

size: 

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

Formats

HTML: 

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

JSON: 

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

GEOJSON: 

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

GPKG: 

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

DXF: 

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

CSV: 

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

SSV: 

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

SMILE: 

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

ZIPJSON: 

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

ZIPSMILE: 

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

Api Model NetLoad

API Model description of NetLoad

Name Type Description
addressIDs int[] Address ID
attributes Map<String,double[]>
buildingID int Building ID
clusterID int Net Cluster ID
connectionState TimeState
id int
maquetteOverride Map<String,double[]>
name String
netType NetType
nodeID int Net Node ID
point Point
sourceIDs int[] Source ID
version int

See also

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