Api session event editor netload generate loads

From Tygron Support wiki
Jump to navigation Jump to search

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, 6799434.882245781 ], [ 658679.2801103322, 6799434.882245781 ], [ 658679.2801103322, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
}, [ "PARK", "SOCIAL", "ROAD" ], 92, 94, [ 1, 2, 3 ], [ 1, 2, 3 ], false ]