Api session event editor overlay set overlay source

From Tygron Support wiki
Jump to navigation Jump to search

API Event to Add or remove specified Source to or from a specified SOURCE Overlay. Unincluded Source which are already related to the Overlay will remain related. Unincluded Source 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 a SOURCES Overlay)
1 REQUIRED (SOURCE Integer ID or multiple values in array [1, 2, 3]) Array of Source IDs
2 REQUIRED (true, false) Should be added to the Overlay (false removes the Source 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_source/?f=JSON&token=API_TOKEN

with content:

[ 32, [ 1, 2, 3 ], true ]