Api session event editor netcluster generate clusters

API Endpoint: editornetcluster/generate_clusters.

Description: 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

Curl example POST:

curl 'https://engine.tygron.com/api/session/event/editornetcluster/generate_clusters/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ "ELECTRICITY", "PER_LOAD", {
 "type" : "MultiPolygon",
 "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]
}, 1, 98, 1, "Text", false, "" ]
'

Curl example multi item POST:

curl 'https://engine.tygron.com/api/session/event/editornetcluster/generate_clusters/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ [ "ELECTRICITY", "GAS", "HEAT" ], "PER_LOAD", {
 "type" : "MultiPolygon",
 "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]
}, [ 1, 2, 3 ], 16, 1, "Text", false, "" ]
'

JavaScript example POST:

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ "ELECTRICITY", "PER_LOAD", { "type" : "MultiPolygon", "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]}, 1, 98, 1, "Text", false, "" ]'
};
fetch("https://engine.tygron.com/api/session/event/editornetcluster/generate_clusters/?crs=3857", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));

See also

• Api session event editor netcluster
• Api session items netclusters