schedule

Event List

Changed on

Event List

get/schedule/{displayGroupId}/events

Request

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

Path parameters

displayGroupIdinteger required

The DisplayGroupId to return the event list for.

Query parameters

singlePointInTimeinteger
datestring

Date in Y-m-d H:i:s. Required when singlePointInTime=1, otherwise ignored. One of date, or startDate/endDate must be supplied, or a 422 is returned.

startDatestring

Date in Y-m-d H:i:s. Required together with endDate when singlePointInTime is not set. One of date, or startDate/endDate must be supplied, or a 422 is returned.

endDatestring

Date in Y-m-d H:i:s. Required together with startDate when singlePointInTime is not set. One of date, or startDate/endDate must be supplied, or a 422 is returned.

Response

successful response

Changes

  • 41c04de98ec5Revision changes
    • info

      added the new optional query request parameter endDate

    • info

      added the new optional query request parameter singlePointInTime

    • info

      added the new optional query request parameter startDate

    • info

      the query request parameter date became optional

  • 8e1275395104Revision changes
    • breaking

      the query request parameter date became required

    • warning

      deleted the query request parameter endDate

    • warning

      deleted the query request parameter singlePointInTime

    • warning

      deleted the query request parameter startDate