Api session event editor netload generate loads: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 67: Line 67:
|}
|}
===Example POST===
===Example POST===
Example POST: https://engine.tygron.com/api/session/event/editornetload/generate_loads/?crs=3857&f=HTML&token=API_TOKEN
Example POST: https://engine.tygron.com/api/session/event/editornetload/generate_loads/?crs=3857&f=JSON&token=API_TOKEN


with content:  
with content:  
<pre>[ "ELECTRICITY", {
<pre>[ "HEAT", {
  "type" : "MultiPolygon",
  "type" : "MultiPolygon",
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799316.823423957 ], [ 658647.156322532, 6799316.823423957 ], [ 658647.156322532, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799398.073031891 ], [ 658770.2593419013, 6799398.073031891 ], [ 658770.2593419013, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
}, [ "SHOPPING", "NATURE", "LEISURE" ], 84, 17, [ 1, 2, 3 ], [ 1, 2, 3 ], true ]
}, [ "OTHER", "BRIDGE", "INDUSTRY" ], 51, 76, [ 1, 2, 3 ], [ 1, 2, 3 ], false ]
</pre>
</pre>
{{article end|seealso=*[[api session event editor netload]]}}
{{article end|seealso=*[[api session event editor netload]]}}


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

Revision as of 08:19, 1 April 2026

API Event to Generate Loads

Name Importance Type Description Values
0 REQUIRED (Enumeration) NetType ELECTRICITY, GAS, HEAT, INTERNET or SEWER
1 REQUIRED (MultiPolygon with crs: EPSG:3857) MultiPolygon
2 REQUIRED (Category or multiple values in array [a, b, c]) Category[]
3 REQUIRED (Integer number) Integer
4 REQUIRED (Integer number) Integer
5 REQUIRED (STAKEHOLDER Integer ID or multiple values in array [1, 2, 3]) Stakeholder
6 REQUIRED (STAKEHOLDER Integer ID or multiple values in array [1, 2, 3]) Stakeholder
7 REQUIRED (true, false) Boolean true or false

Response Codes

Response Code: Description
204 No Content
300-600 Codes Overview

Example POST

Example POST: https://engine.tygron.com/api/session/event/editornetload/generate_loads/?crs=3857&f=JSON&token=API_TOKEN

with content:

[ "HEAT", {
 "type" : "MultiPolygon",
 "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799398.073031891 ], [ 658770.2593419013, 6799398.073031891 ], [ 658770.2593419013, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
}, [ "OTHER", "BRIDGE", "INDUSTRY" ], 51, 76, [ 1, 2, 3 ], [ 1, 2, 3 ], false ]