Api session event editor overlay set overlay area
API Event to Add or remove specified Areas to or from a specified AREAS Overlay. Unincluded Area which are already related to the Overlay will remain related. Unincluded areas which are not related to the Overlay will remain unrelated.
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (OVERLAY Integer ID) | Overlay ID (must relate to an AREAS Overlay) | |
| 1 | REQUIRED | (AREA Integer ID or multiple values in array [1, 2, 3]) | Array of Area IDs | |
| 2 | REQUIRED | (true, false) | Should be added to the Overlay (false removes the Areas from the Overlay) | 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_overlay_area/?f=HTML&token=API_TOKEN
with content:
[ 7, [ 1, 2, 3 ], false ]