Api session event editor netcluster generate clusters
API Event to Generate Clusters
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (NetType or multiple values in array [a, b, c]) | NetType[] | |
| 1 | REQUIRED | (Enumeration) | ClusteringType | ADD_TO_EXISTING_FOR_BUILDINGS, MAP_SECTORS, PER_ATTRIBUTE, PER_BUILDING, PER_LOAD or PER_LOAD_UNIQUE_OWNER |
| 2 | REQUIRED | (MultiPolygon with crs: EPSG:3857) | MultiPolygon | |
| 3 | REQUIRED | (Integer number or multiple values in array [1, 2, 3]) | Integer[] | |
| 4 | REQUIRED | (Floating point number) | Double | |
| 5 | REQUIRED | (STAKEHOLDER Integer ID) | Stakeholder | |
| 6 | REQUIRED | (String) | String | |
| 7 | REQUIRED | (true, false) | Boolean | true or false |
| 8 | OPTIONAL | (Floating point number) | Double |
Response Codes
| Response Code: | Description |
|---|---|
| 204 | No Content |
| 300-600 | Codes Overview |
Example POST
Example POST: https://engine.tygron.com/api/session/event/editornetcluster/generate_clusters/?crs=3857&f=JSON&token=API_TOKEN
with content:
[ [ "HEAT", "ELECTRICITY", "HEAT" ], "PER_LOAD_UNIQUE_OWNER", {
"type" : "MultiPolygon",
"coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799374.403093704 ], [ 658697.2154452165, 6799374.403093704 ], [ 658697.2154452165, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
}, [ 1, 2, 3 ], 28, 22, "Text", true, "" ]