Api session event editor netcluster generate clusters: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
Created page with "API Event to Generate Clusters {|class=wikitable !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]) |Integ..."
 
No edit summary
Line 40: Line 40:
|REQUIRED
|REQUIRED
|(STAKEHOLDER Integer ID)
|(STAKEHOLDER Integer ID)
|[[Stakeholder]]s
|[[Stakeholder]]
|
|
|-
|-
Line 76: Line 76:


with content:  
with content:  
<pre>[ [ "GAS", "HEAT", "INTERNET" ], "PER_LOAD_UNIQUE_OWNER", {
<pre>[ [ "GAS", "SEWER", "HEAT" ], "PER_LOAD_UNIQUE_OWNER", {
  "type" : "MultiPolygon",
  "type" : "MultiPolygon",
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799461.505039563 ], [ 658647.7377632535, 6799461.505039563 ], [ 658647.7377632535, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799459.249114954 ], [ 658670.7079200288, 6799459.249114954 ], [ 658670.7079200288, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
}, [ 1, 2, 3 ], 67, 33, "Text", false, "" ]
}, [ 1, 2, 3 ], 93, 67, "Text", false, "" ]
</pre>
</pre>
{{article end|seealso=*[[api session event editor netcluster]]}}
{{article end|seealso=*[[api session event editor netcluster]]}}


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

Revision as of 07:52, 31 March 2026

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=HTML&token=API_TOKEN

with content:

[ [ "GAS", "SEWER", "HEAT" ], "PER_LOAD_UNIQUE_OWNER", {
 "type" : "MultiPolygon",
 "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799459.249114954 ], [ 658670.7079200288, 6799459.249114954 ], [ 658670.7079200288, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
}, [ 1, 2, 3 ], 93, 67, "Text", false, "" ]