Api session items netloads: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 90: | Line 90: | ||
| addressIDs | | addressIDs | ||
| int<nowiki>[]</nowiki> | | int<nowiki>[]</nowiki> | ||
| [[Address]]es ID | | [[[[Address]]]]es ID | ||
|- | |- | ||
| attributes | | attributes | ||
| Line 98: | Line 98: | ||
| buildingID | | buildingID | ||
| int | | int | ||
| [[Building]] ID | | [[[[Building]]]] ID | ||
|- | |- | ||
| clusterID | | clusterID | ||
| int | | int | ||
| [[Net Cluster]] ID | | [[[[Net Cluster]]]] ID | ||
|- | |- | ||
| connectionState | | connectionState | ||
| TimeState | | TimeState | ||
| | | [[Timestate]] | ||
|- | |- | ||
| id | | id | ||
| Line 122: | Line 122: | ||
| netType | | netType | ||
| NetType | | NetType | ||
| | | [[Net Type]] | ||
|- | |- | ||
| nodeID | | nodeID | ||
| int | | int | ||
| [[Net Node]] ID | | [[[[Net Node]]]] ID | ||
|- | |- | ||
| point | | point | ||
| Point | | Point | ||
| | | [[#Api Model Point|Point]] | ||
|- | |- | ||
| sourceIDs | | sourceIDs | ||
| int<nowiki>[]</nowiki> | | int<nowiki>[]</nowiki> | ||
| [[Source]]s ID | | [[[[Source]]]]s ID | ||
|- | |- | ||
| version | | version | ||
| Line 174: | Line 174: | ||
| type | | type | ||
| String | | String | ||
| [[#Api Model Point|Point]] | | [[#Api Model [[#Api Model Point|Point]]|[[#Api Model Point|Point]]]] | ||
|- | |- | ||
| coordinates | | coordinates | ||
Revision as of 12:57, 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_TOKENExample 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_TOKENPseudo-Mercator:
https://engine.tygron.com/api/session/items/netloads/?crs=3857&token=API_TOKENDegrees:
https://engine.tygron.com/api/session/items/netloads/?crs=4326&token=API_TOKENAmersfoort / RD New:
https://engine.tygron.com/api/session/items/netloads/?crs=28992&token=API_TOKENLocal Coordinates:
https://engine.tygron.com/api/session/items/netloads/?crs=LOCAL&token=API_TOKENbbox=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_TOKENFOO:
https://engine.tygron.com/api/session/items/net_loads-foo/?crs=3857&token=API_TOKENShow Queries
max version:
https://engine.tygron.com/api/session/items/netloads/version/?token=API_TOKENsize:
https://engine.tygron.com/api/session/items/netloads/size/?token=API_TOKENFormats
HTML:
https://engine.tygron.com/api/session/items/netloads/?f=HTML&token=API_TOKENJSON:
https://engine.tygron.com/api/session/items/netloads/?f=JSON&token=API_TOKENGEOJSON:
https://engine.tygron.com/api/session/items/netloads/?f=GEOJSON&token=API_TOKENGPKG:
https://engine.tygron.com/api/session/items/netloads/?f=GPKG&token=API_TOKENDXF:
https://engine.tygron.com/api/session/items/netloads/?f=DXF&token=API_TOKENCSV:
https://engine.tygron.com/api/session/items/netloads/?f=CSV&token=API_TOKENSSV:
https://engine.tygron.com/api/session/items/netloads/?f=SSV&token=API_TOKENSMILE:
https://engine.tygron.com/api/session/items/netloads/?f=SMILE&token=API_TOKENZIPJSON:
https://engine.tygron.com/api/session/items/netloads/?f=ZIPJSON&token=API_TOKENZIPSMILE:
https://engine.tygron.com/api/session/items/netloads/?f=ZIPSMILE&token=API_TOKENApi 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 |