displayGroup

Action: Change Layout

Changed on

Send a change layout action to the provided Display Group. This will be sent to Displays in that Group via XMR.

post/displaygroup/{displayGroupId}/action/changeLayout

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/displaygroup/{displayGroupId}/action/changeLayout
  • Auth
    none declared

Path parameters

displayGroupIdinteger required

This can be either a Display Group or the Display specific Display Group

Request body application/x-www-form-urlencoded

layoutIdinteger

The ID of the Layout to change to. Either this or a campaignId must be provided.

campaignIdinteger

The Layout specific campaignId of the Layout to change to. Either this or a layoutId must be provided.

durationinteger

The duration in seconds for this Layout change to remain in effect, after which normal scheduling is resumed.

downloadRequiredinteger

Flag indicating whether the player should perform a collect before playing the Layout.

changeModestring required

Whether to queue or replace with this action. Queuing will keep the current change layout action and switch after it is finished. If no active change layout action is present, both options are actioned immediately

Response

successful operation

Changes