Back | 

AssetRssGetHdsManifestGetLiveM3u8LoginWsAccountMetadataWsAccountPreferenceWsAnalyticsJobWsAnalyticsReportWsAssetWsAssetAssociatedFileWsAssetAssociatedLinkWsAssetAssociationsWsAssetCaptionFileWsAssetCustomEmbedWsAssetFileWsAssetSubTypeWsChannelWsClientWsDsUserWsEPGDefaultScheduleWsEPGScheduleWsEmbedWsFiletypesWsFolderWsFtpWsFtpAccountWsGoogleAnalyticsReportWsHtml5PlayerWsLiveEventWsLiveNoteWsLiveSeriesWsMidRollAdWsPaletteReportWsPermissionWsPlayerWsPresentationWsPresentationSlideWsProgramWsProgramM3u8WsRandomProgramsWsRecycleAssetWsRelatedProgramsWsScheduleItemsForPlayoutWsSearchProgramsWsSecurityFilterWsSfSyndicationWsSpriteWsSystemDefaultWsThumbnailWsTimezonesWsTranscodeHistoryWsTranscodingProfileWsUnpreparedFilesWsUserWsUserTokenWsVimeoAccountWsVimeoPublishWsVodProjectWsYouTubeAccountWsYouTubePublish

WsScheduleItemsForPlayout

Returns scheduled playout items for channel

URL Format

/ws/ws_schedule_items_for_playout/api/{app_token}/mode/json/apiv/5?channelUUID={channel_uuid}&scheduleId={scheduleId}&startTime={startTime}&endTime={endTime}&timezone={timezone}

Parameters

Name	Req	Type	Description
app_token		string	The api token for the given account. You can find the api token when navigating through account->api accounts
apiv		integer	The api version; only version 5 supported.
channelUUID		string	Channel uuid of the channel to retrieve playout items from
scheduleId		string	Scedule ID of the schedule for the channel to retrieve playout items from
startTime		int	start time for which scheduled items are required. Date must be in t/z format.
endTime		int	end time for which the scheduled items are required. Date must be in t/z format.
timezone		int	timezone of the user in which start and end time are submitted. If not submitted default is set to UTC

Request Headers

Name

Possible Responses

• 619 Schedule Items Found
• 628 Invalid Schedule
• 102 Invalid app token

Example Response

{
  "response": {
    "success": {
      "code": 619,
      "message": "Schedule Items Found",
      "details": ""
    },
    "WsScheduleItemsForPlayaoutResponse": {
      "items": [
        {
          "class": "PlayoutItem",
          "startTime": "2018-07-05T07:00:00Z",
          "duration": 86400000,
          "mediaType": 1,
          "mediaId": 2375151,
          "isActive": 1,
          "isDeleted": 0,
          "source": [
            
          ]
        }
      ]
    }
  }
}