Api session event editor netsetting set boolean: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 10: | Line 10: | ||
!Values | !Values | ||
|- | |- | ||
|0 | | 0 | ||
|REQUIRED | | REQUIRED | ||
|(Enumeration) | | (Enumeration) | ||
|Type | | Type | ||
|CLUSTER_FRACTION_CONNECTED, CLUSTER_MODELS_ENABLED, ELECTRICITY_ACTIVE, ELECTRICITY_FLOW_ATTRIBUTE, ELECTRICITY_NETWORK_OWNER_ID, FIRST_CONNECT_ACCEPT, GAS_ACTIVE, GAS_FLOW_ATTRIBUTE, GAS_NETWORK_OWNER_ID, HEAT_ACTIVE, HEAT_FLOW_ATTRIBUTE, HEAT_NETWORK_OWNER_ID, INTERNET_ACTIVE, INTERNET_FLOW_ATTRIBUTE, INTERNET_NETWORK_OWNER_ID, LOAD_TO_NODE_LINES_ENABLED, REQUIRE_UTILITY_CORPORATION_APPROVAL, RESTRICT_TO_NET_OVERLAY, SEWER_ACTIVE, SEWER_FLOW_ATTRIBUTE or SEWER_NETWORK_OWNER_ID | | CLUSTER_FRACTION_CONNECTED, CLUSTER_MODELS_ENABLED, ELECTRICITY_ACTIVE, ELECTRICITY_FLOW_ATTRIBUTE, ELECTRICITY_NETWORK_OWNER_ID, FIRST_CONNECT_ACCEPT, GAS_ACTIVE, GAS_FLOW_ATTRIBUTE, GAS_NETWORK_OWNER_ID, HEAT_ACTIVE, HEAT_FLOW_ATTRIBUTE, HEAT_NETWORK_OWNER_ID, INTERNET_ACTIVE, INTERNET_FLOW_ATTRIBUTE, INTERNET_NETWORK_OWNER_ID, LOAD_TO_NODE_LINES_ENABLED, REQUIRE_UTILITY_CORPORATION_APPROVAL, RESTRICT_TO_NET_OVERLAY, SEWER_ACTIVE, SEWER_FLOW_ATTRIBUTE or SEWER_NETWORK_OWNER_ID | ||
|- | |- | ||
|1 | | 1 | ||
|REQUIRED | | REQUIRED | ||
|(true, false) | | (true, false) | ||
|Boolean | | Boolean | ||
|true or false | | true or false | ||
|} | |} | ||
===Response Codes=== | ===Response Codes=== | ||
| Line 27: | Line 27: | ||
!Description | !Description | ||
|- | |- | ||
|204 | | 204 | ||
|No Content | | No Content | ||
|- | |- | ||
|300-600 | | 300-600 | ||
|Codes Overview | | Codes Overview | ||
|} | |} | ||
===Example POST=== | ===Example POST=== | ||
| Line 37: | Line 37: | ||
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editornetsetting/set_boolean/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ "CLUSTER_FRACTION_CONNECTED", true ]' | <syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editornetsetting/set_boolean/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ "CLUSTER_FRACTION_CONNECTED", true ]' | ||
</syntaxhighlight> | </syntaxhighlight> | ||
JavaScript example POST: | JavaScript example POST: | ||
Revision as of 11:40, 8 June 2026
API Endpoint: api/session/event/editornetsetting/set_boolean/
Description: Set Boolean
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (Enumeration) | Type | CLUSTER_FRACTION_CONNECTED, CLUSTER_MODELS_ENABLED, ELECTRICITY_ACTIVE, ELECTRICITY_FLOW_ATTRIBUTE, ELECTRICITY_NETWORK_OWNER_ID, FIRST_CONNECT_ACCEPT, GAS_ACTIVE, GAS_FLOW_ATTRIBUTE, GAS_NETWORK_OWNER_ID, HEAT_ACTIVE, HEAT_FLOW_ATTRIBUTE, HEAT_NETWORK_OWNER_ID, INTERNET_ACTIVE, INTERNET_FLOW_ATTRIBUTE, INTERNET_NETWORK_OWNER_ID, LOAD_TO_NODE_LINES_ENABLED, REQUIRE_UTILITY_CORPORATION_APPROVAL, RESTRICT_TO_NET_OVERLAY, SEWER_ACTIVE, SEWER_FLOW_ATTRIBUTE or SEWER_NETWORK_OWNER_ID |
| 1 | REQUIRED | (true, false) | Boolean | 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/editornetsetting/set_boolean/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ "CLUSTER_FRACTION_CONNECTED", true ]'JavaScript example POST:
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ "CLUSTER_FRACTION_CONNECTED", true ]'
};
fetch("https://engine.tygron.com/api/session/event/editornetsetting/set_boolean/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));