Api session event editor netcluster remove network: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
API Endpoint: api/session/event/editornetcluster/remove_network/ | API Endpoint: api/session/event/editornetcluster/remove_network/ | ||
Description: Remove Network | Description: Remove a Network of a particular [[Net Type]], with the option to keep the Root Load. | ||
{|class=wikitable | {|class=wikitable | ||
| Line 13: | Line 13: | ||
| REQUIRED | | REQUIRED | ||
| (Enumeration) | | (Enumeration) | ||
| [[Net | | [[Net Cluster]] | ||
| ELECTRICITY, GAS, HEAT, INTERNET or SEWER | | ELECTRICITY, GAS, HEAT, INTERNET or SEWER | ||
|- | |- | ||
| Line 19: | Line 19: | ||
| REQUIRED | | REQUIRED | ||
| (true, false) | | (true, false) | ||
| | | Keep Root Load | ||
| true or false | | true or false | ||
|} | |} | ||
Revision as of 15:30, 10 November 2026
API Endpoint: api/session/event/editornetcluster/remove_network/
Description: Remove a Network of a particular Net Type, with the option to keep the Root Load.
| Index | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (Enumeration) | Net Cluster | ELECTRICITY, GAS, HEAT, INTERNET or SEWER |
| 1 | REQUIRED | (true, false) | Keep Root Load | true or false |
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/remove_network/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ "ELECTRICITY", true ]'JavaScript example POST
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ "ELECTRICITY", true ]'
};
fetch("https://engine.tygron.com/api/session/event/editornetcluster/remove_network/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));