Api session event editor overlay set net overlay
API Event to Set the visualization style for a specified network Overlay.
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (OVERLAY Integer ID) | Overlay ID (must relate to a network Overlay) | |
| 1 | REQUIRED | (Enumeration) | NetType | ELECTRICITY, GAS, HEAT, INTERNET or SEWER |
| 2 | REQUIRED | (true, false) | Whether to show the network (false means no lines will be visualized) | true or false |
| 3 | REQUIRED | (true, false) | Whether only active connections should be visualized (false means both active and inactive connections are visualized) | true or false |
Response Codes
| Response Code: | Description |
|---|---|
| 204 | No Content |
| 300-600 | Codes Overview |
Example POST
Example POST: https://engine.tygron.com/api/session/event/editoroverlay/set_net_overlay/?f=HTML&token=API_TOKEN
with content:
[ 80, "HEAT", false, false ]