background

Client API

  1. Features
  2. Client API

We expose a coherent RESTful API that powers the Freeform Client Apps across native mobile and OTT.

While not an exhaustive list, the Client API powers the following areas of the platform:

  • Config
  • Feeds
  • Programming
  • Editorial Content
  • Schedule
  • Identity and User
  • Search
  • License Plates
  • Recommendations

ShowMS Client API - Documentation from Swagger

GET /config/{environment}/{platform}

Summary: Get the config for a given environment and platform

Paramaters
Name Located in Description Required Schema
environment path Yes string
platform path Yes string
api-version header api-version header No string
Responses
Code Description Schema
200 OK object
400 Bad Request
500 Internal Server Error

GET /feeds/samsung_tizen.json.gz

Summary: Get the feed for supplied url name

Paramaters
Name Located in Description Required Schema
api-version header api-version header No string
Responses
Code Description Schema
200 OK TizenFeedBase

GET /feeds/googlehome

Summary: Get the feed of shows and movies for integrating with Google Home

Paramaters
Name Located in Description Required Schema
api-version header api-version header No string
Responses
Code Description Schema
200 OK object

GET /feeds/roku

Summary: Get the feed of shows and movies for integrating with Google Home

Paramaters
Name Located in Description Required Schema
api-version header api-version header No string
Responses
Code Description Schema
200 OK RokuFeedBase

GET /feeds/googlemedia

Summary: Get the feed for supplied url name

Paramaters
Name Located in Description Required Schema
api-version header api-version header No string
Responses
Code Description Schema
200 OK GoogleFeed

GET /lookup/{partnerApiId}

Summary: Get content for a given partner api id

Paramaters
Name Located in Description Required Schema
partnerApiId path Yes string
api-version header api-version header No string
Responses
Code Description Schema
200 OK ProgrammingCollectionItemDto

GET /feeds/{feedUrl}

Summary: Get the feed for supplied url name

Paramaters
Name Located in Description Required Schema
feedUrl path Yes string
api-version header api-version header No string
Responses
Code Description Schema
200 OK object

GET /ContentFeed

Summary: Get the feed for supplied url name

Paramaters
Name Located in Description Required Schema
api-version header api-version header No string
Responses
Code Description Schema
200 OK TizenFeedBase

POST /licenseplate

Summary: Create a license plate

Paramaters
Name Located in Description Required Schema
input body License plate request Yes ActivationCodeCreateInput
api-version header api-version header No string
Responses
Code Description Schema
200 OK ActivationCodeDto
400 BadRequest

GET /licenseplate/{code}

Summary: Check the status of a license plate by code

Paramaters
Name Located in Description Required Schema
code path License plate code Yes string
api-version header api-version header No string
Responses
Code Description Schema
200 OK ActivationCodeDto
404 NotFound

POST /licenseplate/activate/{code}

Summary: Create a license plate

Paramaters
Name Located in Description Required Schema
code path License plate code Yes string
input body License plate user input Yes ActivationCodeActivateInput
api-version header api-version header No string
Responses
Code Description Schema
200 OK ActivationCodeDto
400 BadRequest

GET /programming/shows

Summary: Get all shows

Paramaters
Name Located in Description Required Schema
api-version header api-version header No string
Responses
Code Description Schema
200 OK [ProgrammingCollectionItemDto ]

GET /programming/shows/categories/{category}

Summary: Get all shows with categories

Paramaters
Name Located in Description Required Schema
category path Yes string
api-version header api-version header No string
Responses
Code Description Schema
200 OK [ProgrammingCollectionItemDto ]

GET /programming/homepage/rows/{rowName}

Summary: Gets an individual row that can appear on the homepage

Paramaters
Name Located in Description Required Schema
rowName path URL safe name of the row Yes string
userId query The Freeform User ID of the current user No string
api-version header api-version header No string
Responses
Code Description Schema
200 OK ProgrammingCollectionDto

GET /programming/upnext/{videoId}

Summary: Get up next video for current video

Paramaters
Name Located in Description Required Schema
videoId path The ID of the current video (for episodes and movies the partner API ID or for clips the ShowMS ID) Yes string
userId query Optionally include the ID of the user so their viewing history can be used to improve response No string
api-version header api-version header No string
Responses
Code Description Schema
200 OK ProgrammingCollectionItemDto

GET /programming/movies

Summary: Get all movies

Paramaters
Name Located in Description Required Schema
userId query The Freeform User ID of the user No string
api-version header api-version header No string
Responses
Code Description Schema
200 OK [ProgrammingCollectionItemDto ]

GET /programming/movies/categories/{category}

Summary: Get all movies

Paramaters
Name Located in Description Required Schema
category path Yes string
userId query The Freeform User ID of the user No string
api-version header api-version header No string
Responses
Code Description Schema
200 OK [ProgrammingCollectionItemDto ]

GET /programming/movies/{movieName}

Summary: Get a movie

Paramaters
Name Located in Description Required Schema
movieName path The name of the movie Yes string
userId query The Freeform User ID of the user No string
api-version header api-version header No string
Responses
Code Description Schema
200 OK ProgrammingMovieDto
404 NotFound object

GET /programming/movies/{movieName}/extras

Summary: Get the first page of clips and articles for a movie

Paramaters
Name Located in Description Required Schema
movieName path The name of the movie Yes string
api-version header api-version header No string
Responses
Code Description Schema
200 OK ProgrammingExtrasDto
404 NotFound object

GET /programming/{sectionName}/season3

Summary: Get the seasons for a section

Paramaters
Name Located in Description Required Schema
sectionName path The PartnerApiId or URL of the Section Yes string
userId query The Freeform User ID of the user No string
api-version header api-version header No string
Responses
Code Description Schema
200 OK [ProgrammingSeasonDto ]
404 NotFound object

GET /programming/{sectionName}/seasons/{seasonNumber}

Summary: Get the episodes for a season

Paramaters
Name Located in Description Required Schema
sectionName path The PartnerApiId or URL of the Section Yes string
seasonNumber path Season Number Yes integer
userId query The Freeform User ID of the user No string
api-version header api-version header No string
Responses
Code Description Schema
200 OK ProgrammingSeasonDto
400 BadRequest object
404 NotFound object

GET /programming/{sectionName}/seasons/{seasonNumber}/episode

Summary: Get the episodes for a season

Paramaters
Name Located in Description Required Schema
sectionName path The PartnerApiId or URL of the Section Yes string
seasonNumber path Season Number Yes integer
userId query The Freeform User ID of the user No string
api-version header api-version header No string
Responses
Code Description Schema
200 OK [ProgrammingCollectionItemDto ]
400 BadRequest object
404 NotFound object

GET /programming/{sectionName}/seasons/{seasonNumber}/episodes/{episodeUrlName

Summary: Get an episode for a season and section

Paramaters
Name Located in Description Required Schema
sectionName path The PartnerApiId or URL of the Section Yes string
seasonNumber path Season Number Yes integer
episodeUrlName path The URL of the episode Yes string
userId query The Freeform User ID of the user No string
api-version header api-version header No string
Responses
Code Description Schema
200 OK ProgrammingCollectionItemDto
400 BadRequest object
404 NotFound object

GET /programming/episodes/{partnerApiId}

Summary: Get an episode with its partner api id

Paramaters
Name Located in Description Required Schema
partnerApiId path The PartnerApiId of the Episode Yes string
userId query The Freeform User ID of the user No string
api-version header api-version header No string
Responses
Code Description Schema
200 OK ProgrammingCollectionItemDto

GET /programming/homepage

Summary: Get the home page programming for a given user

Paramaters
Name Located in Description Required Schema
userId query The Freeform User ID of the user No string
api-version header api-version header No string
Responses
Code Description Schema
200 OK ProgrammingHomePageDto

GET /programming/{sectionName}/extras

Summary: Get the first page of clips and articles for a section

Paramaters
Name Located in Description Required Schema
sectionName path The PartnerApiId or URL of the Section Yes string
api-version header api-version header No string
Responses
Code Description Schema
200 OK ProgrammingExtrasDto

GET /programming/{sectionName}/cast

Summary:

Get all the cast members for a section

Paramaters
Name Located in Description Required Schema
sectionName path The PartnerApiId or URL of the Section Yes string
api-version header api-version header No string
Responses
Code Description Schema
200 OK [ProgrammingCastMemberDto ]

GET /programming/{sectionName}/articles

Summary: Get the articles for a section

Paramaters
Name Located in Description Required Schema
sectionName path The PartnerApiId or URL of the Section Yes string
pageIndex query No integer
api-version header api-version header No string
Responses
Code Description Schema
200 OK [ProgrammingArticleDto ]
404 NotFound object

GET /programming/{sectionName}/articles/{articleUrlName}

Summary: Get an article from a section

Paramaters
Name Located in Description Required Schema
sectionName path The PartnerApiId or URL of the Section Yes string
articleUrlName path The article URL name Yes string
api-version header api-version header No string
Responses
Code Description Schema
200 OK ProgrammingArticleDto
404 NotFound object

GET /programming/{sectionName}/clips

Summary: Get the clips for a section

Paramaters
Name Located in Description Required Schema
sectionName path The PartnerApiId or URL of the Section Yes string
pageIndex query No integer
api-version header api-version header No string
Responses
Code Description Schema
200 OK [ProgrammingCollectionItemDto ]
404 NotFound object

GET /programming/{sectionName}/clips/{clipUrlName}

Summary: Get a clip for a section

Paramaters
Name Located in Description Required Schema
sectionName path The PartnerApiId or URL of the Section Yes string
clipUrlName path The clip URL name Yes string
api-version header api-version header No string
Responses
Code Description Schema
200 OK ProgrammingCollectionItemDto
404 NotFound object

GET /programming/clips/{clipId}

Summary: Get a clip from its ID

Paramaters
Name Located in Description Required Schema
clipId path For VPPO clips, the Partner API ID of the clip. For ShowMS clips, the ShowMS ID of the clip. Yes string
api-version header api-version header No string
Responses
Code Description Schema
200 OK ProgrammingCollectionItemDto

GET /programming/{sectionName}

Summary:

Get a section

Summary: Optionally include user's id in the query param to including continue watching data in response.

Paramaters
Name Located in Description Required Schema
sectionName path The PartnerApiId or URL of the Section Yes string
userId query The Freeform User ID of the user No string
api-version header api-version header No string
Responses
Code Description Schema
200 OK ProgrammingSectionDto
404 NotFound object

GET /Programming

Summary:

Get a section

Summary: Optionally include user's id in the query param to including continue watching data in response.

Paramaters
Name Located in Description Required Schema
sectionName query The PartnerApiId or URL of the Section Yes string
userId query The Freeform User ID of the user No string
api-version header api-version header No string
Responses
Code Description Schema
200 OK ProgrammingSectionDto
404 NotFound object

GET /schedule

Summary: Get a complete list of schedule items for a given day and timezone offset

Paramaters
Name Located in Description Required Schema
input.day query Yes dateTime
input.timezoneOffset query Yes integer
api-version header api-version header No string
Responses
Code Description Schema
200 OK ScheduleDto
400 Bad Request
404 Schedule not found
500 Internal Server Error

GET /schedule/nowandnext

Summary: Get the now and next items for all feeds

Paramaters
Name Located in Description Required Schema
timezoneOffset query No integer
api-version header api-version header No string
Responses
Code Description Schema
200 OK ScheduleNowNextFeedDto
400 Bad Request
404 Schedule not found
500 Internal Server Error

GET /search

Summary: Searches shows and movies for the given search term

Paramaters
Name Located in Description Required Schema
searchTerm query String to search for Yes string
userId query No string
includeExternal query Option to include external results No boolean
api-version header api-version header No string
Responses
Code Description Schema
200 OK SearchResultsDto
500 Internal Server Error

GET /status

Summary:

Get status and region

Paramaters
Name Located in Description Required Schema
api-version header api-version header No string
Responses
Code Description Schema
200 OK object

GET /version

Summary:

Get version

Paramaters
Name Located in Description Required Schema
api-version header api-version header No string
Responses
Code Description Schema
200 OK object

POST /users

Summary: Updates or creates a user with the given user id

Description:

Platform should be one of "android", "ios", "web", "tvos", "androidtv", "firetv", "tizen" or "roku".

Optionally TV provider can be included if known.

Paramaters
Name Located in Description Required Schema
user body A description of the user Yes OneIdUserInput
api-version header api-version header No string
Responses
Code Description Schema
200 OK OneIdUserWithViewingHistoryDto
400 BadRequest object

GET /users/{userId}

Summary:

Get a user by their Freeform User ID

Paramaters
Name Located in Description Required Schema
userId path The Freeform ID of the user Yes string
api-version header api-version header No string
Responses
Code Description Schema
200 OK OneIdUserWithViewingHistoryDto
404 NotFound object

GET /users/{userId}/viewinghistory

Summary:

Get the viewing history for a user

Description:

All times are in seconds.

Paramaters
Name Located in Description Required Schema
userId path The Freeform User ID of the user Yes string
api-version header api-version header No string
Responses
Code Description Schema
200 OK ViewingHistoryDto
404 NotFound object

PUT

Summary: Update a user's viewing history

Description:

This method can be used to record either a user's history as they watch or to merge their offline viewing history.

For items that already exist in the user's history the most recent progress will be saved.

Progress is in seconds.

Paramaters
Name Located in Description Required Schema
userId path The Freeform User ID of the user Yes string
viewingHistory body A list of viewing history items Yes ViewingHistoryApiInput
api-version header api-version header No string
Responses
Code Description Schema
200 OK Void
400 BadRequest object
404 NotFound object

PUT /users/{userId}/tvprovider

Summary:

Update a user's TV provider

Description:

TV provider can contain either the user's current TV provider ID or a TV provider status (either "none" if the user has stated they have no TV provider or "unknown")

Paramaters
Name Located in Description Required Schema
userId path The Freeform User ID of the user Yes string
tvProvider body The user's current TV provider state Yes TvProviderInput
api-version header api-version header No string
Responses
Code Description Schema
200 OK OneIdUserDto
400 BadRequest object
404 NotFound object

GET /users/{userId}/recommendations

Summary:

Gets the current recommendations for the user

Paramaters
Name Located in Description Required Schema
userId path The Freeform User ID of the current user Yes string
api-version header api-version header No string
Responses
Code Description Schema
200 OK ProgrammingCollectionDto

Models

tizenFeedBase
Name Type Description Required
programs [TizenProgram ] No
tizenProgram
Name Type Description Required
ids [TizenProgramId ] No
external_ids [TizenProgramExternalId ] No
titles [TizenTitle ] No
season_number integer No
episode_number integer No
type string No
content_items [TizenContentItem ] No
descriptions [TizenDescription ] No
images [TizenImage ] No
show_id TizenProgramId No
season_id TizenProgramId No
air_date string No
release_date string No
running_time integer No
genres [ string ] No
tizenProgramId
Name Type Description Required
id string No
id_type string No
tizenProgramExternalId
Name Type Description Required
id string No
id_type string No
provider string No
tizenTitle
Name Type Description Required
title string No
language string No
type string No
length integer No
tizenContentItem
Name Type Description Required
id string No
type string No
country_codes [ string ] No
url string No
playback_options [TizenPlaybackOption ] No
tizenDescription
Name Type Description Required
description string No
language string No
type string No
length integer No
tizenImage
Name Type Description Required
url string No
width integer No
height integer No
type string No
tizenPlaybackOption
Name Type Description Required
quality string No
license string No
available_starting string No
available_ending string No
feedRowDto
Name Type Description Required
shows [ string ] No
movies [ string ] No
rokuFeedBase
Name Type Description Required
movies [RokuMovie ] No
seriesItems [RokuSeries ] No
rokuMovie
Name Type Description Required
title string No
videos [RokuVideo ] No
tmsId string No
rokuSeries
Name Type Description Required
title string No
episodes [RokuEpisode ] No
tmsId string No
rokuVideo
Name Type Description Required
region string No
playId string No
options [RokuVideoOption ] No
rokuEpisode
Name Type Description Required
title string No
videos [RokuVideo ] No
tmsId string No
rokuVideoOption
Name Type Description Required
price string No
currency string No
quality string No
license string No
googleFeed
Name Type Description Required
@context string No
@type string No
dateModified dateTime No
dataFeedElement [DataFeedElement ] No
dataFeedElement
Name Type Description Required
@context string No
@id string No
@type string No
name string No
url string No
description string No
releasedEvent ReleasedEvent No
potentialAction PotentialAction No
episodeNumber integer No
seasonNumber integer No
partOfSeason PartOfSeason No
partOfSeries PartOfSeries No
releasedEvent
Name Type Description Required
@type string No
startDate dateTime No
location Location No
potentialAction
Name Type Description Required
@type string No
target [Target ] No
expectsAcceptanceOf ExpectsAcceptanceOf No
partOfSeason
Name Type Description Required
@context string No
@id string No
@type string No
seasonNumber integer No
partOfSeries
Name Type Description Required
@context string No
@id string No
@type string No
name string No
location
Name Type Description Required
@type string No
name string No
target
Name Type Description Required
@type string No
urlTemplate string No
actionPlatform [ string ] No
expectsAcceptanceOf
Name Type Description Required
@type string No
category string No
availabilityStarts dateTime No
availabilityEnds dateTime No
eligibleRegion EligibleRegion No
eligibleRegion
Name Type Description Required
@type string No
name string No
programmingCollectionItemDto
Name Type Description Required
partnerApiId string No
itemType string No
title string No
images [ProgrammingImageDto ] No
apiEndpoint string No
appDeepLink string No
urlName string No
requiresSignIn boolean No
continueWatching ContinueWatchingDto No
fullEpisodeNumber string No
showTitle string No
showPrefix string No
description string No
longDescription string No
duration integer No
rating string No
descriptors string No
airDate dateTime No
numberOfEpisodes integer No
numberOfSeasons integer No
videoUrl string No
ccAvailability boolean No
availableDate dateTime No
genre string No
displayGenre string No
showMsId string No
number integer No
seasonNumber integer No
label string No
editorialTagline string No
availabilityNotice string No
trailer ProgrammingCollectionItemDto No
theme ProgrammingSectionThemeDto No
externalUrl string No
networkColor string No
backgroundColor string No
prefix string No
sectionTitle string No
show ProgrammingCollectionItemDto No
showStatus string No
status string No
url string No
tmsId string No
programmingImageDto
Name Type Description Required
name string No
sizes [ProgrammingImageSizeDto ] No
continueWatchingDto
Name Type Description Required
percentComplete integer No
resumeTime integer No
isAdPlaying boolean No
updatedAt double No
programmingSectionThemeDto
Name Type Description Required
themeName string No
themeColor string No
textColor string No
programmingImageSizeDto
Name Type Description Required
size string No
width integer No
height integer No
url string No
activationCodeCreateInput
Name Type Description Required
action string No
platform string Yes
device string No
userId string No
activationCodeDto
Name Type Description Required
code string No
status string No
user OneIdUserDto No
oneIdUserDto
Name Type Description Required
isNew boolean No
userId string No
swid string No
firstName string No
tvProvider TvProviderDto No
hasSignedOut boolean No
tvProviderDto
Name Type Description Required
tvProviderId string No
tvProviderStatus string No
activationCodeActivateInput
Name Type Description Required
userId string Yes
programmingListWithCategoriesDto
Name Type Description Required
items [ProgrammingCollectionItemDto ] No
categories [ProgrammingCategoryDto ] No
programmingCategoryDto
Name Type Description Required
name string No
endpoint string No
programmingCollectionDto
Name Type Description Required
title string No
linkText string No
apiEndpoint string No
items [ProgrammingCollectionItemDto ] No
programmingMovieDto
Name Type Description Required
moreLikeThis [ProgrammingCollectionItemDto ] No
fullAdLoadRequired boolean No
labels [ProgrammingLabelDto ] No
cast [ProgrammingCastMemberDto ] No
partnerApiId string No
itemType string No
title string No
images [ProgrammingImageDto ] No
apiEndpoint string No
appDeepLink string No
urlName string No
requiresSignIn boolean No
continueWatching ContinueWatchingDto No
fullEpisodeNumber string No
showTitle string No
showPrefix string No
description string No
longDescription string No
duration integer No
rating string No
descriptors string No
airDate dateTime No
numberOfEpisodes integer No
numberOfSeasons integer No
videoUrl string No
ccAvailability boolean No
availableDate dateTime No
genre string No
displayGenre string No
showMsId string No
number integer No
seasonNumber integer No
label string No
editorialTagline string No
availabilityNotice string No
trailer ProgrammingCollectionItemDto No
theme ProgrammingSectionThemeDto No
externalUrl string No
networkColor string No
backgroundColor string No
prefix string No
sectionTitle string No
show ProgrammingCollectionItemDto No
showStatus string No
status string No
url string No
tmsId string No
programmingLabelDto
Name Type Description Required
key string No
value string No
programmingCastMemberDto
Name Type Description Required
name string No
character string No
images [ProgrammingImageDto ] No
socialAccounts [ProgrammingCastMemberSocialAccountDto ] No
programmingCastMemberSocialAccountDto
Name Type Description Required
url string No
type string No
programmingExtrasDto
Name Type Description Required
articles [ProgrammingArticleDto ] No
clips [ProgrammingCollectionItemDto ] No
articlePageCount integer No
clipPageCount integer No
programmingArticleDto
Name Type Description Required
embedUrl string No
partnerApiId string No
itemType string No
title string No
images [ProgrammingImageDto ] No
apiEndpoint string No
appDeepLink string No
urlName string No
requiresSignIn boolean No
continueWatching ContinueWatchingDto No
fullEpisodeNumber string No
showTitle string No
showPrefix string No
description string No
longDescription string No
duration integer No
rating string No
descriptors string No
airDate dateTime No
numberOfEpisodes integer No
numberOfSeasons integer No
videoUrl string No
ccAvailability boolean No
availableDate dateTime No
genre string No
displayGenre string No
showMsId string No
number integer No
seasonNumber integer No
label string No
editorialTagline string No
availabilityNotice string No
trailer ProgrammingCollectionItemDto No
theme ProgrammingSectionThemeDto No
externalUrl string No
networkColor string No
backgroundColor string No
prefix string No
sectionTitle string No
show ProgrammingCollectionItemDto No
showStatus string No
status string No
url string No
tmsId string No
programmingSeasonDto
Name Type Description Required
episodes [ProgrammingCollectionItemDto ] No
partnerApiId string No
itemType string No
title string No
images [ProgrammingImageDto ] No
apiEndpoint string No
appDeepLink string No
urlName string No
requiresSignIn boolean No
continueWatching ContinueWatchingDto No
fullEpisodeNumber string No
showTitle string No
showPrefix string No
description string No
longDescription string No
duration integer No
rating string No
descriptors string No
airDate dateTime No
numberOfEpisodes integer No
numberOfSeasons integer No
videoUrl string No
ccAvailability boolean No
availableDate dateTime No
genre string No
displayGenre string No
showMsId string No
number integer No
seasonNumber integer No
label string No
editorialTagline string No
availabilityNotice string No
trailer ProgrammingCollectionItemDto No
theme ProgrammingSectionThemeDto No
externalUrl string No
networkColor string No
backgroundColor string No
prefix string No
sectionTitle string No
show ProgrammingCollectionItemDto No
showStatus string No
status string No
url string No
tmsId string No
modelState
Name Type Description Required
value ValueProviderResult No
errors [ModelError ] No
valueProviderResult
Name Type Description Required
attemptedValue string No
culture string No
rawValue object No
modelError
Name Type Description Required
exception object No
errorMessage string No
programmingHomePageDto
Name Type Description Required
hero ProgrammingHomeHeroDto No
collections [ProgrammingCollectionDto ] No
continueWatching [ProgrammingCollectionItemDto ] No
programmingHomeHeroDto
Name Type Description Required
content ProgrammingCollectionItemDto No
heroId string No
images [ProgrammingImageDto ] No
links [ProgrammingHomeHeroLinkDto ] No
title string No
urlName string No
useDarkText boolean No
programmingHomeHeroLinkDto
Name Type Description Required
apiEndpoint string No
appDeepLink string No
itemType string No
partnerApiId string No
title string No
urlName string No
programmingPagedCollectionDto[ProgrammingArticleDto]
Name Type Description Required
items [ProgrammingArticleDto ] No
pageIndex integer No
pageCount integer No
programmingPagedCollectionDto[ProgrammingCollectionItemDto]
Name Type Description Required
items [ProgrammingCollectionItemDto ] No
pageIndex integer No
pageCount integer No
programmingSectionDto
Name Type Description Required
title string No
description string No
longDescription string No
itemType string No
continueWatching ProgrammingCollectionItemDto No
trailer ProgrammingCollectionItemDto No
airDate dateTime No
rating string No
hasArticles boolean No
hasClips boolean No
hasSchedule boolean No
scheduleUrl string No
moreLikeThis [ProgrammingCollectionItemDto ] No
images [ProgrammingImageDto ] No
genre string No
displayGenre string No
appDeepLink string No
urlName string No
apiEndpoint string No
notificationCopy string No
availabilityNotice string No
theme ProgrammingSectionThemeDto No
labels [ProgrammingLabelDto ] No
editorialTagline string No
getScheduleInputWithDay
Name Type Description Required
day dateTime Yes
timezoneOffset integer Yes
scheduleDto
Name Type Description Required
days [ScheduleDayDto ] No
items [ProgrammingScheduleItemWithTimeRemainingDto ] No
scheduleDayDto
Name Type Description Required
date dateTime No
isCurrent boolean No
url string No
programmingScheduleItemWithTimeRemainingDto
Name Type Description Required
timeRemaining string No
startTime dateTime No
onNow boolean No
feed string No
isNew boolean No
partnerApiId string No
itemType string No
title string No
images [ProgrammingImageDto ] No
apiEndpoint string No
appDeepLink string No
urlName string No
requiresSignIn boolean No
continueWatching ContinueWatchingDto No
fullEpisodeNumber string No
showTitle string No
showPrefix string No
description string No
longDescription string No
duration integer No
rating string No
descriptors string No
airDate dateTime No
numberOfEpisodes integer No
numberOfSeasons integer No
videoUrl string No
ccAvailability boolean No
availableDate dateTime No
genre string No
displayGenre string No
showMsId string No
number integer No
seasonNumber integer No
label string No
editorialTagline string No
availabilityNotice string No
trailer ProgrammingCollectionItemDto No
theme ProgrammingSectionThemeDto No
externalUrl string No
networkColor string No
backgroundColor string No
prefix string No
sectionTitle string No
show ProgrammingCollectionItemDto No
showStatus string No
status string No
url string No
tmsId string No
scheduleNowNextFeedDto
Name Type Description Required
east [ProgrammingScheduleItemWithTimeRemainingDto ] No
west [ProgrammingScheduleItemWithTimeRemainingDto ] No
searchResultsDto
Name Type Description Required
topResult ProgrammingCollectionItemDto No
groups [SearchResultsSection ] No
searchResultsSection
Name Type Description Required
title string No
results [ProgrammingCollectionItemDto ] No
oneIdUserInput
Name Type Description Required
swid string No
userId string No
firstName string No
platform string Yes
tvProviderId string No
tvProviderStatus string No
hasSignedOut boolean No
deviceId string No
oneIdUserWithViewingHistoryDto
Name Type Description Required
viewingHistory [ProgrammingCollectionItemDto ] No
isNew boolean No
userId string No
swid string No
firstName string No
tvProvider TvProviderDto No
hasSignedOut boolean No
viewingHistoryDto
Name Type Description Required
items [ProgrammingCollectionItemDto ] No
viewingHistoryApiInput
Name Type Description Required
items [ViewingHistoryItemApiInput ] No
viewingHistoryItemApiInput
Name Type Description Required
partnerApiId string Yes
progress double No
updatedAt dateTime No
isAdPlaying boolean No
void
Name Type Description Required
tvProviderInput
Name Type Description Required
tvProviderId string No
tvProviderStatus string No