Sign in
scheduleitems

Changed on

Video events schedule

list: Query parameters

date: YYYY-MM-DD or 'today' (Europe/Oslo). Defaults to today.

days: Number of days. Defaults to 1.

surrounding: Include event before and after the window.

ordering: Field to order by. Prefix '-' for desc. Defaults to 'starttime'.

patch/api/scheduleitems/{id}

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Authorization
    • API key in cookie sessionid

Path parameters

idinteger required

A unique integer value identifying this TX schedule entry.

Request body

videointeger nullable
schedulereason1 | 2 | 3 | 4 | 5
  • 1 - Legacy
  • 2 - Administrative
  • 3 - User
  • 4 - Automatic
  • 5 - Jukebox
starttimestring date-time
durationstring

Response

idinteger required
videointeger nullable
schedulereason1 | 2 | 3 | 4 | 5
  • 1 - Legacy
  • 2 - Administrative
  • 3 - User
  • 4 - Automatic
  • 5 - Jukebox
starttimestring date-time required
endtimestring date-time required
durationstring required

Changes

  • e220966e8fa5Revision changes
    • info

      removed the max_value enum value from the ////////// response property for the response status

    • info

      removed the min_value enum value from the ////////// response property for the response status

  • 2bacf53705f7Revision changes
    • breaking

      api path removed without deprecation

    • info

      endpoint added