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, Bureaucrats, Interface administrators, Administrators
41,010 edits
No edit summary
No edit summary
Line 21: Line 21:
   "point" : null,
   "point" : null,
   "sourceIDs" : [ ],
   "sourceIDs" : [ ],
   "version" : 81
   "version" : 1
}, {
}, {
   "addressIDs" : [ 90 ],
   "addressIDs" : [ 90 ],
Line 37: Line 37:
   "point" : null,
   "point" : null,
   "sourceIDs" : [ 12 ],
   "sourceIDs" : [ 12 ],
   "version" : 82
   "version" : 2
} ]</syntaxhighlight>
} ]</syntaxhighlight>
==Limit Queries==
==Limit Queries==
Line 88: Line 88:
!Description
!Description
|-
|-
|addressIDs
| addressIDs
|int<nowiki>[]</nowiki>
| int<nowiki>[]</nowiki>
|[[Address]]es ID  
| [[Address]]es ID  
|-
|-
|attributes
| attributes
|Map&lt;String,double[]&gt;
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|buildingID
| buildingID
|int
| int
|[[Building]] ID  
| [[Building]] ID  
|-
|-
|clusterID
| clusterID
|int
| int
|[[Net Cluster]] ID  
| [[Net Cluster]] ID  
|-
|-
|connectionState
| connectionState
|TimeState
| TimeState
|
|  
|-
|-
|id
| id
|int
| int
|
|  
|-
|-
|maquetteOverride
| maquetteOverride
|Map&lt;String,double[]&gt;
| Map&lt;String,double[]&gt;
|
|  
|-
|-
|name
| name
|String
| String
|
|  
|-
|-
|netType
| netType
|NetType
| NetType
|
|  
|-
|-
|nodeID
| nodeID
|int
| int
|[[Net Node]] ID  
| [[Net Node]] ID  
|-
|-
|point
| point
|Point
| Point
|
|  
|-
|-
|sourceIDs
| sourceIDs
|int<nowiki>[]</nowiki>
| int<nowiki>[]</nowiki>
|[[Source]]s ID  
| [[Source]]s ID  
|-
|-
|version
| version
|int
| int
|
|  
|}
|}


Line 148: Line 148:
!Description
!Description
|-
|-
|ELECTRICITY
| ELECTRICITY
|
|  
|-
|-
|GAS
| GAS
|
|  
|-
|-
|HEAT
| HEAT
|
|  
|-
|-
|INTERNET
| INTERNET
|
|  
|-
|-
|SEWER
| SEWER
|
|  
|}
|}


Line 172: Line 172:
!Description
!Description
|-
|-
|type
| type
|String
| String
|[[#Api Model Point|Point]]
| [[#Api Model Point|Point]]
|-
|-
|coordinates
| coordinates
|double[]
| double[]
|x, y, (optional) z
| x, y, (optional) z
|}
|}


Line 188: Line 188:
!Description
!Description
|-
|-
|NOTHING
| NOTHING
|
|  
|-
|-
|WAITING_FOR_DATE
| WAITING_FOR_DATE
|
|  
|-
|-
|REQUEST_PLOT_OWNER_APPROVAL
| REQUEST_PLOT_OWNER_APPROVAL
|
|  
|-
|-
|REQUEST_ZONING_APPROVAL
| REQUEST_ZONING_APPROVAL
|
|  
|-
|-
|REQUEST_CONSTRUCTION_APPROVAL
| REQUEST_CONSTRUCTION_APPROVAL
|
|  
|-
|-
|CONSTRUCTION_APPROVED
| CONSTRUCTION_APPROVED
|
|  
|-
|-
|CONSTRUCTION_DENIED
| CONSTRUCTION_DENIED
|
|  
|-
|-
|PENDING_CONSTRUCTION
| PENDING_CONSTRUCTION
|
|  
|-
|-
|CONSTRUCTING
| CONSTRUCTING
|
|  
|-
|-
|READY
| READY
|
|  
|-
|-
|PENDING_UPGRADE
| PENDING_UPGRADE
|
|  
|-
|-
|WAITING_FOR_DEMOLISH_DATE
| WAITING_FOR_DEMOLISH_DATE
|
|  
|-
|-
|REQUEST_DEMOLISH_ZONING_APPROVAL
| REQUEST_DEMOLISH_ZONING_APPROVAL
|
|  
|-
|-
|REQUEST_DEMOLISH_APPROVAL
| REQUEST_DEMOLISH_APPROVAL
|
|  
|-
|-
|DEMOLISH_APPROVED
| DEMOLISH_APPROVED
|
|  
|-
|-
|DEMOLISH_DENIED
| DEMOLISH_DENIED
|
|  
|-
|-
|PENDING_DEMOLISHING
| PENDING_DEMOLISHING
|
|  
|-
|-
|DEMOLISHING
| DEMOLISHING
|
|  
|-
|-
|DEMOLISH_FINISHED
| DEMOLISH_FINISHED
|
|  
|}
|}


Revision as of 11:44, 8 June 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

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[] Addresses 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[] 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=84387"