Api session event editor netload generate loads: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
Newer edit →
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Interface administrators, Administrators
27,393 edits
Created page with "API Event to Generate Loads {|class=wikitable !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 valu..."
 
No edit summary
Line 40: Line 40:
|REQUIRED
|REQUIRED
|(STAKEHOLDER Integer ID or multiple values in array [1, 2, 3])
|(STAKEHOLDER Integer ID or multiple values in array [1, 2, 3])
|[[Stakeholder]]s
|[[Stakeholder]]
|
|
|-
|-
Line 46: Line 46:
|REQUIRED
|REQUIRED
|(STAKEHOLDER Integer ID or multiple values in array [1, 2, 3])
|(STAKEHOLDER Integer ID or multiple values in array [1, 2, 3])
|[[Stakeholder]]s
|[[Stakeholder]]
|
|
|-
|-
Line 70: Line 70:


with content:  
with content:  
<pre>[ "HEAT", {
<pre>[ "ELECTRICITY", {
  "type" : "MultiPolygon",
  "type" : "MultiPolygon",
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799357.489540914 ], [ 658676.8568992801, 6799357.489540914 ], [ 658676.8568992801, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799316.823423957 ], [ 658647.156322532, 6799316.823423957 ], [ 658647.156322532, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
}, [ "LUXE", "SENIOR", "EDUCATION" ], 37, 99, [ 1, 2, 3 ], [ 1, 2, 3 ], true ]
}, [ "SHOPPING", "NATURE", "LEISURE" ], 84, 17, [ 1, 2, 3 ], [ 1, 2, 3 ], true ]
</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 07:52, 31 March 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=HTML&token=API_TOKEN

with content: 

[ "ELECTRICITY", {
 "type" : "MultiPolygon",
 "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799316.823423957 ], [ 658647.156322532, 6799316.823423957 ], [ 658647.156322532, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
}, [ "SHOPPING", "NATURE", "LEISURE" ], 84, 17, [ 1, 2, 3 ], [ 1, 2, 3 ], true ]

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_event_editor_netload_generate_loads&oldid=67542"