Api session items netloads: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older 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
 
(3 intermediate revisions by the same user not shown)
Line 21: Line 21:
   "point" : null,
   "point" : null,
   "sourceIDs" : [ ],
   "sourceIDs" : [ ],
   "version" : 11
   "version" : 51
}, {
}, {
   "addressIDs" : [ 90 ],
   "addressIDs" : [ 90 ],
Line 37: Line 37:
   "point" : null,
   "point" : null,
   "sourceIDs" : [ 12 ],
   "sourceIDs" : [ 12 ],
   "version" : 12
   "version" : 52
} ]</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 Model NetLoad==
API Enumeration description of LoadAttribute
API Model description of NetLoad


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|CONNECTION_COST
|addressIDs
|
|int<nowiki>[]</nowiki>
|[[Address]] ID
|-
|-
|FLOW
|attributes
|Map&lt;String,double[]&gt;
|
|
|-
|-
|POWER
|buildingID
|
|int
|[[Building]] ID
|-
|-
|CONNECTION_COUNT
|clusterID
|
|int
|[[Net Cluster]] ID
|-
|-
|FLOOR_SPACE_M2
|connectionState
|TimeState
|
|
|-
|-
|TYPE
|id
|int
|
|
|-
|-
|ROOT_LOAD
|maquetteOverride
|Map&lt;String,double[]&gt;
|
|
|-
|-
|LOAD_COUNT
|name
|String
|
|
|-
|-
|ADDRESS_COUNT
|netType
|NetType
|
|
|-
|-
|CONNECTION_FRACTION
|nodeID
|
|int
|[[Net Node]] ID
|-
|-
|PRESSURE_M_H2O_SUPPLY
|point
|Point
|
|
|-
|-
|PRESSURE_M_H2O_RETURN
|sourceIDs
|
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|-
|TEMPERATURE_SUPPLY_DEGREES_CELSIUS
|version
|int
|
|
|}
|}


==Api Model LoadCostSegment==
==Api Model NetType==
API Model description of LoadCostSegment
API Enumeration description of NetType


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|-
|baseCost
|ELECTRICITY
|double
|
|-
|GAS
|
|-
|HEAT
|
|
|-
|-
|incrCost
|INTERNET
|double
|
|
|-
|-
|minValue
|SEWER
|int
|
|
|}
|}


==Api Model LoadParameterType==
==Api Model Point==
API Enumeration description of LoadParameterType
API Model description of Point


{|class=wikitable
{|class=wikitable
!Name
!Name
!Type
!Description
!Description
|-
|FLOW
|
|-
|POWER
|
|-
|CONNECTION_COST
|
|-
|CONNECTION
|
|-
|FLOOR_SPACE_M2
|
|}
|}


==Api Model LoadType==
==Api Model TimeState==
API Enumeration description of LoadType
API Enumeration description of TimeState


{|class=wikitable
{|class=wikitable
Line 178: Line 180:
!Description
!Description
|-
|-
|UNKNOWN
|NOTHING
|
|
|-
|-
|COLLECTIVE
|WAITING_FOR_DATE
|
|
|-
|-
|COLLECTIVE_TAP
|REQUEST_PLOT_OWNER_APPROVAL
|
|
|-
|-
|COLLECTIVE_RADIATOR
|REQUEST_ZONING_APPROVAL
|
|
|-
|-
|COLLECTIVE_RADIATOR_TAP
|REQUEST_CONSTRUCTION_APPROVAL
|
|
|-
|-
|INDIVIDUAL
|CONSTRUCTION_APPROVED
|
|
|-
|-
|LARGE_SCALE_CONSUMER
|CONSTRUCTION_DENIED
|
|
|}
==Api Model NetLoad==
API Model description of NetLoad
{|class=wikitable
!Name
!Type
!Description
|-
|-
|addressIDs
|PENDING_CONSTRUCTION
|int<nowiki>[]</nowiki>
|
|[[Address]] ID
|-
|-
|attributes
|CONSTRUCTING
|Map&lt;String,double[]&gt;
|
|
|-
|-
|buildingID
|READY
|int
|
|[[Building]] ID
|-
|-
|clusterID
|PENDING_UPGRADE
|int
|
|[[Net Cluster]] ID
|-
|-
|connectionState
|WAITING_FOR_DEMOLISH_DATE
|TimeState
|
|
|-
|-
|id
|REQUEST_DEMOLISH_ZONING_APPROVAL
|int
|
|
|-
|-
|maquetteOverride
|REQUEST_DEMOLISH_APPROVAL
|Map&lt;String,double[]&gt;
|
|
|-
|-
|name
|DEMOLISH_APPROVED
|String
|
|
|-
|-
|netType
|DEMOLISH_DENIED
|NetType
|
|
|-
|-
|nodeID
|PENDING_DEMOLISHING
|int
|
|[[Net Node]] ID
|-
|-
|point
|DEMOLISHING
|Point
|
|
|-
|-
|sourceIDs
|DEMOLISH_FINISHED
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|version
|int
|
|
|}
|}
Line 266: Line 243:


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

Latest revision as of 14:14, 24 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" : 51
}, {
  "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" : 52
} ]

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

Api Model NetType

API Enumeration description of NetType

Name Description
ELECTRICITY
GAS
HEAT
INTERNET
SEWER

Api Model Point

API Model description of Point

Name Type Description

Api Model TimeState

API Enumeration description of TimeState

Name Description
NOTHING
WAITING_FOR_DATE
REQUEST_PLOT_OWNER_APPROVAL
REQUEST_ZONING_APPROVAL
REQUEST_CONSTRUCTION_APPROVAL
CONSTRUCTION_APPROVED
CONSTRUCTION_DENIED
PENDING_CONSTRUCTION
CONSTRUCTING
READY
PENDING_UPGRADE
WAITING_FOR_DEMOLISH_DATE
REQUEST_DEMOLISH_ZONING_APPROVAL
REQUEST_DEMOLISH_APPROVAL
DEMOLISH_APPROVED
DEMOLISH_DENIED
PENDING_DEMOLISHING
DEMOLISHING
DEMOLISH_FINISHED

See also

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