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'.

get/api/scheduleitems

Request

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

Query parameters

datestring date
daysnumber
limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

orderingstring

Which field to use when ordering the results.

surroundingboolean

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Changes

  • e1828b395fe4Revision changes
    • warning

      added the new dash_preview enum value to the ///////////// response property for the response status

  • 3761c2b166bbRevision changes
    • info

      added the optional property /////// to the response with the status