Api session items netloads

From Tygron Support wiki
Jump to navigation Jump to search

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[] [[Address]]es 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[] [[Source]]s 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 [[#Api Model Point|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