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, Bureaucrats, Interface administrators, Administrators
46,429 edits
No edit summary
No edit summary
 
(40 intermediate revisions by the same user not shown)
Line 1: Line 1:
api session items [[Net Load]]s Endpoints.
API Endpoint: /api/session/items/netloads/


Manipulate items with event: [[Api session event editor netload|editornetload]].
Edit items with events described at [[Api session event editor netload]].


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" : 0,
  "maquetteOverride" : null,
  "name" : "NetLoad 0",
  "netType" : "ELECTRICITY",
  "nodeID" : 0,
  "point" : null,
  "sourceIDs" : [ ],
  "version" : 1
}, {
  "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" : 2
} ]</syntaxhighlight>
==Limit Queries==
==Limit Queries==
version=100:  
version=100:  
<pre>https://engine.tygron.com/api/session/items/netloads/?version=100&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netloads/?version=100&token=API_TOKEN</syntaxhighlight>
Pseudo-Mercator:  
Pseudo-Mercator:  
<pre>https://engine.tygron.com/api/session/items/netloads/?crs=3857&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netloads/?crs=3857&token=API_TOKEN</syntaxhighlight>
Degrees:  
Degrees:  
<pre>https://engine.tygron.com/api/session/items/netloads/?crs=4326&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netloads/?crs=4326&token=API_TOKEN</syntaxhighlight>
Amersfoort / RD New:  
Amersfoort / RD New:  
<pre>https://engine.tygron.com/api/session/items/netloads/?crs=28992&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netloads/?crs=28992&token=API_TOKEN</syntaxhighlight>
Local Coordinates:  
Local Coordinates:  
<pre>https://engine.tygron.com/api/session/items/netloads/?crs=LOCAL&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netloads/?crs=LOCAL&token=API_TOKEN</syntaxhighlight>
bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785:  
bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785:  
<pre>https://engine.tygron.com/api/session/items/netloads/?crs=3857&bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netloads/?crs=3857&bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785&token=API_TOKEN</syntaxhighlight>
FOO:  
FOO:  
<pre>https://engine.tygron.com/api/session/items/net_loads-foo/?crs=3857&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/net_loads-foo/?crs=3857&token=API_TOKEN</syntaxhighlight>
==Show Queries==
==Get Queries==
attributes:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netloads/attributes/?token=API_TOKEN</syntaxhighlight>
max version:  
max version:  
<pre>https://engine.tygron.com/api/session/items/netloads/version/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netloads/version/?token=API_TOKEN</syntaxhighlight>
size:  
count:  
<pre>https://engine.tygron.com/api/session/items/netloads/size/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netloads/count/?token=API_TOKEN</syntaxhighlight>
==Formats==
==Formats==
HTML:  
HTML:  
<pre>https://engine.tygron.com/api/session/items/netloads/?f=HTML&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netloads/?f=HTML&token=API_TOKEN&crs=3857</syntaxhighlight>
JSON:  
JSON:  
<pre>https://engine.tygron.com/api/session/items/netloads/?f=JSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netloads/?f=JSON&token=API_TOKEN&crs=3857</syntaxhighlight>
GEOJSON:  
GEOJSON:  
<pre>https://engine.tygron.com/api/session/items/netloads/?f=GEOJSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netloads/?f=GEOJSON&token=API_TOKEN&crs=3857</syntaxhighlight>
GPKG:  
GPKG:  
<pre>https://engine.tygron.com/api/session/items/netloads/?f=GPKG&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netloads/?f=GPKG&token=API_TOKEN&crs=3857</syntaxhighlight>
DXF:  
DXF:  
<pre>https://engine.tygron.com/api/session/items/netloads/?f=DXF&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netloads/?f=DXF&token=API_TOKEN&crs=3857</syntaxhighlight>
CSV:  
CSV:  
<pre>https://engine.tygron.com/api/session/items/netloads/?f=CSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netloads/?f=CSV&token=API_TOKEN&crs=3857</syntaxhighlight>
SSV:  
SSV:  
<pre>https://engine.tygron.com/api/session/items/netloads/?f=SSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netloads/?f=SSV&token=API_TOKEN&crs=3857</syntaxhighlight>
SMILE:  
SMILE:  
<pre>https://engine.tygron.com/api/session/items/netloads/?f=SMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netloads/?f=SMILE&token=API_TOKEN&crs=3857</syntaxhighlight>
ZIPJSON:  
ZIPJSON:  
<pre>https://engine.tygron.com/api/session/items/netloads/?f=ZIPJSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netloads/?f=ZIPJSON&token=API_TOKEN&crs=3857</syntaxhighlight>
ZIPSMILE:  
ZIPSMILE:  
<pre>https://engine.tygron.com/api/session/items/netloads/?f=ZIPSMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netloads/?f=ZIPSMILE&token=API_TOKEN&crs=3857</syntaxhighlight>
{{article end|seealso=*[[Api Content Items]]}}
==Api Model NetLoad==
API Model description of NetLoad
 
{|class=wikitable
!Name
!Type
!Description
|-
| addressIDs
| int<nowiki>[]</nowiki>
| [[Address]]es ID
|-
| attributes
| Map&lt;String,double[]&gt;
|
|-
| buildingID
| int
| [[Building]] ID
|-
| clusterID
| int
| [[Net Cluster]] ID
|-
| connectionState
| TimeState
| [[Timestate]]
|-
| id
| int
|
|-
| maquetteOverride
| Map&lt;String,double[]&gt;
|
|-
| name
| String
|
|-
| netType
| NetType
| [[Net Type]]
|-
| nodeID
| int
| [[Net Node]] ID
|-
| point
| Point
| [[Point]]
|-
| sourceIDs
| int<nowiki>[]</nowiki>
| [[Source]]s ID
|-
| version
| int
|
|}
 
==Api Model NetType==
API Enumeration description of NetType
 
{|class=wikitable
!Name
!Description
|-
| ELECTRICITY
|
|-
| GAS
|
|-
| HEAT
|
|-
| INTERNET
|
|-
| SEWER
|
|}
 
==Api Model Point==
API Model description of Point
 
{|class=wikitable
!Name
!Type
!Description
|-
| type
| String
| [[Point]]
|-
| coordinates
| double[]
| x, y, (optional) z
|}
 
==Api Model TimeState==
API Enumeration description of TimeState
 
{|class=wikitable
!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
|
|}
 
{{article end|seealso=*[[Api Content Items]]
*[[Api session event editor netload]]
}}


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

Latest revision as of 07:14, 7 July 2026

API Endpoint: /api/session/items/netloads/

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

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" : 1
}, {
  "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" : 2
} ]

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

Get Queries

attributes: 

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

max version: 

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

count: 

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

Formats

HTML: 

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

JSON: 

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

GEOJSON: 

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

GPKG: 

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

DXF: 

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

CSV: 

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

SSV: 

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

SMILE: 

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

ZIPJSON: 

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

ZIPSMILE: 

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

Api Model NetLoad

API Model description of NetLoad

Name Type Description
addressIDs int[] Addresses ID
attributes Map<String,double[]>
buildingID int Building ID
clusterID int Net Cluster ID
connectionState TimeState Timestate
id int
maquetteOverride Map<String,double[]>
name String
netType NetType Net Type
nodeID int Net Node ID
point Point Point
sourceIDs int[] Sources 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
type String Point
coordinates double[] x, y, (optional) z

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=89389"