widget

Set Widget From/To Dates

Changed on

Control when this Widget is active on this Playlist

put/playlist/widget/{widgetId}/expiry

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/playlist/widget/{widgetId}/expiry
  • Auth
    none declared

Path parameters

widgetIdinteger required

Id of a widget to which you want to add audio or edit existing audio

Request body application/x-www-form-urlencoded

fromDtstring

The From Date in Y-m-d H::i:s format

toDtstring

The To Date in Y-m-d H::i:s format

deleteOnExpiryinteger

Delete this Widget when it expires?

Response

successful operation

widgetIdinteger

The Widget ID

playlistIdinteger

The ID of the Playlist this Widget belongs to

ownerIdinteger

The ID of the User that owns this Widget

typestring

The Module Type Code

durationinteger

The duration in seconds this widget should be shown

displayOrderinteger

The display order of this widget

useDurationinteger

Flag indicating if this widget has a duration that should be used

calculatedDurationinteger

Calculated Duration of this widget after taking into account the useDuration flag

createdDtstring

The datetime the Layout was created

modifiedDtstring

The datetime the Layout was last modified

fromDtinteger

Widget From Date

toDtinteger

Widget To Date

schemaVersioninteger

Widget Schema Version

transitionIninteger

Transition Type In

transitionOutinteger

Transition Type out

transitionDurationIninteger

Transition duration in

transitionDurationOutinteger

Transition duration out

mediaIdsinteger[]

An array of MediaIds this widget is linked to

playliststring

The name of the Playlist this Widget is on

Changes

  • 41c04de98ec5Revision changes
    • breaking

      added required request body

    • info

      added the media type application/json for the response with the status

  • 8e1275395104Revision changes
    • breaking

      removed the request body

    • breaking

      removed the media type application/json for the response with the status