RedBeeMedia

Returns the textual, technical, cast data, and media (images and video) related to a program.

get

Returns the textual, technical, cast data, and media (images and video) related to a program.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
ProgramIdstringRequired

Must contain a lookup value identifying the program.

ProgramDetailsbooleanOptional

Toggles Program Details on and off within the intended response.

CastInfobooleanOptional

Toggles Cast Info on and off within the intended response.

MediaInfobooleanOptional

Toggles Media Info on and off within the intended response.

MediaDetailsbooleanOptional

Toggles Media Details, such as available videos and images, on and off within the intended response.

SeasonInfobooleanOptional

Toggles Season Info on and off within the intended response.

LanguageCodestringOptional

Lookup value identifying the program's language. Example input: ‘1’ for English.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeProgram

_MediaInfoSpecifiedbooleanOptional
_ProgramDetailsSpecifiedbooleanOptional
_ShortTitlestringOptional
_ShortDescriptionstringOptional
_ShowTypestringOptional
_LanguagestringOptional
_IDinteger · int32Optional
_Parent_Program_IDinteger · int32Optional
get
/ProgramData

Returns the textual and seasonal information related to a program.

get

Returns the textual and seasonal information related to a program.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
ProgramIdstringRequired

Must contain a lookup value identifying the program.

ProgramDetailsbooleanOptional

Toggles on program details when true.

EntityDetailsbooleanOptional

Toggles on entity details when true.

CastInfobooleanOptional

Toggles on cast info when true.

MediaInfobooleanOptional

Toggles Media Info on and off within the intended response.

MediaDetailsbooleanOptional

Toggles Media Details, such as available videos and images, on and off within the intended response.

SeasonNumberstringOptional

Lookup value identifying the program's season number. Example input: ‘1’ for Season 1.

LanguageCodestringOptional

Lookup value identifying the program's language. Example input: ‘1’ for English.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeProgramSeasons

get
/ProgramSeasons

Returns up to 15 matches that share common genres, categories and other data points with the provided program.

get

Returns up to 15 matches that share common genres, categories and other data points with the provided program.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
ProgramIdstringRequired

Must contain a lookup value identifying the program.

ProgramDetailsbooleanOptional

Toggles Program Details on and off within the intended response.

MediaInfobooleanOptional

Toggles Media Info on and off within the intended response.

MediaDetailsbooleanOptional

Toggles Media Details, such as available videos and images, on and off within the intended response.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeProgramResponse

_SOSinteger · int32Optional
_ShowTypeCountinteger · int32Optional
_EpisodeCountinteger · int32Optional
_FullNamestringOptional
_CharacterstringOptional
_RolestringOptional
get
/RelatedPrograms

Returns a list of entertainment award wins and nominations linked to a program and its cast.

get

Returns a list of entertainment award wins and nominations linked to a program and its cast.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
ProgramIdstringRequired

Must contain a lookup value identifying the program.

AwardStatusstringOptional

Contains either no value to return wins/nominations, a filter to return only wins or a filter to exclude wins. Example input: ‘WON’ for wins; ‘NOMINATED’ for losses.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeAward

_WonbooleanOptional
_YearstringOptional
_AwardShowstringOptional
_AwardCategorystringOptional
get
/ProgramAwards

Returns the episodes in which the given entity has a role.

get

Returns the episodes in which the given entity has a role.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
ProgramIdstringRequired

Must contain a lookup value identifying the program.

EntityIdstringRequired

Contains a lookup value identifying the entity.

ProgramDetailsbooleanOptional

Toggles Program Details on and off within the intended response.

MediaInfobooleanOptional

Toggles Media Info on and off within the intended response.

MediaDetailsbooleanOptional

Toggles Media Details, such as available videos and images, on and off within the intended response.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeProgramResponse

_SOSinteger · int32Optional
_ShowTypeCountinteger · int32Optional
_EpisodeCountinteger · int32Optional
_FullNamestringOptional
_CharacterstringOptional
_RolestringOptional
get
/ProgramEpisodesByEntity

Returns a given program's official website, social media resources, hashtags and other external references.

get

Returns a given program's official website, social media resources, hashtags and other external references.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
ProgramIdstringRequired

Must contain a lookup value identifying the program.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeReference

_ReferenceNamestringOptional
_DescriptionstringOptional
_URLstringOptional
get
/ProgramReferences

Returns program title(s) based on a keyword search.

get

Returns program title(s) based on a keyword search.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
KeywordstringRequired

Must contain a URL-encoded keyword parameter used to search for a program title.

ProgramDetailsbooleanOptional

Toggles Program Details on and off within the intended response.

CastInfobooleanOptional

Toggles Cast Info on and off within the intended response.

EntityDetailsbooleanOptional

Toggles Entity Details on and off within the intended response.

MediaInfobooleanOptional

Toggles Media Info on and off within the intended response.

MediaDetailsbooleanOptional

Toggles Media Details, such as available videos and images, on and off within the intended response.

SeasonInfobooleanOptional

Toggles on season info when true.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeProgram

_MediaInfoSpecifiedbooleanOptional
_ProgramDetailsSpecifiedbooleanOptional
_ShortTitlestringOptional
_ShortDescriptionstringOptional
_ShowTypestringOptional
_LanguagestringOptional
_IDinteger · int32Optional
_Parent_Program_IDinteger · int32Optional
get
/ProgramSearch

Returns a list of upcoming airings associated to a given program based on a specific timeframe and headend.

get

Returns a list of upcoming airings associated to a given program based on a specific timeframe and headend.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
ProgramIdstringRequired

Must contain a lookup value identifying the program.

HeadendIdstringRequired

Must contain a lookup value identifying a headend.

HeadendTypestring · enumRequired

Must contain a lookup enumerator that specifies the headend classification or distribution method.

Possible values:
StartDateTimestring · date-timeRequired

Must contain a start date and time formatted per ISO 8601 standards (yyyy-MM-ddThh-mm-ss). Example input: ‘2014-11-05T23-00-00’ for 11/05/2014 at 11 p.m.Note: Always use ‘00’ for ‘ss’ (seconds). To maximize your application’s performance, FYI recommends that when you insert a time, whether through a system’s current time or otherwise, always round to the nearest 5 minute interval.

DurationstringOptional

Contains a value expressed in minutes that determines the amount of airing data returned in the response.

TimeZoneOffsetstringOptional

Contains a UTC offset value expressed in minutes that converts the response to a specific time zone. Example input: ‘-360’ for Central Standard Time.

ProgramDetailsbooleanOptional

Toggles Program Details on and off within the intended response.

AiringDetailsbooleanOptional

Toggles Airing Details on and off within the intended response.

LineupDetailsbooleanOptional

Toggles Lineup Details on and off within the intended response.

StationDetailsbooleanOptional

Toggles Station Details on and off within the intended response.

StationIdsstring[]Optional

Contains either no value to return all stations, a Station ID to return one station, or multiple Station IDs separated by commas to return many stations.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeAiring

_StartTimestring · date-timeOptional
_EndTimestring · date-timeOptional
_LanguagestringOptional
_StationSpecifiedbooleanOptional
_AiringDetailsSpecifiedbooleanOptional
get
/ProgramAirings

Returns information about available media such as images and videos for a given program.

get

Returns information about available media such as images and videos for a given program.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
ProgramIdstringRequired

Must contain a lookup value identifying the program.

MediaDetailsbooleanOptional

Toggles Media Details, such as available videos and images, on and off within the intended response.

OtherMediabooleanOptional

Toggles Other Media details on and off within the intended response.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeMediaAssets

get
/ProgramMedia

Returns all entities associated to the given program.

get

Returns all entities associated to the given program.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
ProgramIdstringRequired

Must contain a lookup value identifying the program.

EntityDetailsbooleanOptional

Toggles Entity Details on and off within the intended response.

MediaInfobooleanOptional

Toggles Media Info on and off within the intended response.

MediaDetailsbooleanOptional

Toggles Media Details, such as available videos and images, on and off within the intended response.

RoleTypesstring · enumOptional

Contains either no value to return all Role Types, one value for a single Role Type or multiple values separated by commas for many Role Types.

Possible values:
Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeCastinfo

_FullNamestringOptional
_CharacterNamestringOptional
_RolestringOptional
_PositionstringOptional
_MainCastbooleanOptional
_RoleTypestringOptional
get
/PrrogramEntitiesByRole

Returns a list of episodes in which a specified entity appears or is part of the production. The request passes across a numerical ID identifying an entity (entity_id) and the parent-level program (pid) to search for episodes in which the entity is attributed.

get

Returns a list of episodes in which a specified entity appears or is part of the production. The request passes across a numerical ID identifying an entity (entity_id) and the parent-level program (pid) to search for episodes in which the entity is attributed.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
ProgramIdstringRequired

Must contain a lookup value identifying the program.

EntityIdstringRequired

Contains a lookup value identifying the entity.

ProgramDetailsbooleanOptional

Toggles Program Details on and off within the intended response.

CastInfobooleanOptional

Toggles Cast Info on and off within the intended response.

MediaInfobooleanOptional

Toggles Media Info on and off within the intended response.

MediaDetailsbooleanOptional

Toggles Media Details, such as available videos and images, on and off within the intended response.

RecordCountinteger · int32Required

Contains either no value to return all records in the request or a number to control the number of returned records.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeProgramResponse

_SOSinteger · int32Optional
_ShowTypeCountinteger · int32Optional
_EpisodeCountinteger · int32Optional
_FullNamestringOptional
_CharacterstringOptional
_RolestringOptional
get
/PrrogramEntityEpisodes

Returns information related to entertainers, athletes, production companies and other entities.

get

Returns information related to entertainers, athletes, production companies and other entities.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
EntityIdstringRequired

Contains a lookup value identifying the entity.

EntityDetailsbooleanOptional

Toggles Entity Details on and off within the intended response.

MediaInfobooleanOptional

Toggles Media Info on and off within the intended response.

MediaDetailsbooleanOptional

Toggles Media Details, such as available videos and images, on and off within the intended response.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeEntity

_MediaInfoSpecifiedbooleanOptional
_IDinteger · int32Optional
_KnownNamestringOptional
_EntityInfoSpecifiedbooleanOptional
get
/EntityInformation

Returns a list of programs associated to the provided entity.

get

Returns a list of programs associated to the provided entity.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
EntityIdstringRequired

Contains a lookup value identifying the entity.

ProgramDetailsbooleanOptional

Toggles Program Details on and off within the intended response.

MediaInfobooleanOptional

Toggles Media Info on and off within the intended response.

MediaDetailsbooleanOptional

Toggles Media Details, such as available videos and images, on and off within the intended response.

ProgramTypestring · enumOptional

Contains either no value to return all Program Types, or one Program Type for a single filter

Possible values:
Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeProgramResponse

_SOSinteger · int32Optional
_ShowTypeCountinteger · int32Optional
_EpisodeCountinteger · int32Optional
_FullNamestringOptional
_CharacterstringOptional
_RolestringOptional
get
/EntityFilmography

Returns a given entity’s official website, social media resources and other external references.

get

Returns a given entity’s official website, social media resources and other external references.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
EntityIdstringRequired

Contains a lookup value identifying the entity.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeReference

_ReferenceNamestringOptional
_DescriptionstringOptional
_URLstringOptional
get
/EntityReferences

Returns notable facts about a given entity such as trivia, quotes, trade and acclaim.

get

Returns notable facts about a given entity such as trivia, quotes, trade and acclaim.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
EntityIdstringRequired

Contains a lookup value identifying the entity.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeEntityFact

_FactNamestringOptional
_DescriptionstringOptional
get
/EntityFacts

Returns a list of entertainment award wins and nominations linked to an entity.

get

Returns a list of entertainment award wins and nominations linked to an entity.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
EntityIdstringRequired

Contains a lookup value identifying the entity.

AwardStatusstring · enumOptional

Contains either no value to return wins/nominations, a filter to return only wins or a filter to exclude wins. Example input: ‘WON’ for wins; ‘NOMINATED’ for losses.

Possible values:
Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeAward

_WonbooleanOptional
_YearstringOptional
_AwardShowstringOptional
_AwardCategorystringOptional
get
/EntityAwards

Returns a list of upcoming airings associated to a given entity based on a specific timeframe and headend.

get

Returns a list of upcoming airings associated to a given entity based on a specific timeframe and headend.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
EntityIdstringRequired

Contains a lookup value identifying the entity.

HeadendIdstringRequired

Must contain a lookup value identifying a headend.

HeadendTypestring · enumRequired

Must contain a lookup enumerator that specifies the headend classification or distribution method.

Possible values:
StartDateTimestring · date-timeRequired

Must contain a start date and time formatted per ISO 8601 standards (yyyy-MM-ddThh-mm-ss). Example input: ‘2014-11-05T23-00-00’ for 11/05/2014 at 11 p.m.Note: Always use ‘00’ for ‘ss’ (seconds). To maximize your application’s performance, FYI recommends that when you insert a time, whether through a system’s current time or otherwise, always round to the nearest 5 minute interval.

DurationstringOptional

Contains a value expressed in minutes that determines the amount of airing data returned in the response.

TimeZoneOffsetstringOptional

Contains a UTC offset value expressed in minutes that converts the response to a specific time zone. Example input: ‘-360’ for Central Standard Time.

ProgramDetailsbooleanOptional

Toggles on program details when true.

AiringDetailsbooleanOptional

Toggles Airing Details on and off within the intended response.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeAiring

_StartTimestring · date-timeOptional
_EndTimestring · date-timeOptional
_LanguagestringOptional
_StationSpecifiedbooleanOptional
_AiringDetailsSpecifiedbooleanOptional
get
/EntityAppearances

Returns information about available media and images for an entity.

get

Returns information about available media and images for an entity.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
EntityIdstringRequired

Contains a lookup value identifying the entity.

MediaDetailsbooleanOptional

Toggles Media Details, such as available videos and images, on and off within the intended response.

OtherMediabooleanOptional

Toggles Other Media details on and off within the intended response.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeMediaAssets

get
/EntityMedia

Returns entities based on a provided keyword search.

get

Returns entities based on a provided keyword search.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
KeywordstringRequired

Must contain a URL-encoded keyword parameter used to search for a program title.

EntityDetailsbooleanOptional

Toggles on entity details when true.

MediaInfobooleanOptional

Toggles on media info when true.

MediaDetailsbooleanOptional

Toggles on media details when true.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeEntity

_MediaInfoSpecifiedbooleanOptional
_IDinteger · int32Optional
_KnownNamestringOptional
_EntityInfoSpecifiedbooleanOptional
get
/EntitySearchKeyword

Returns linear schedule data associated to one or more stations based on a specific timeframe and headend.

get

Returns linear schedule data associated to one or more stations based on a specific timeframe and headend.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
StationIdstringRequired

Must contain a lookup value identifying a station.

HeadendIdstringRequired

Must contain a lookup value identifying a headend.

HeadendTypestring · enumRequired

Must contain a lookup enumerator that specifies the headend classification or distribution method.

Possible values:
StartDateTimestring · date-timeRequired

Must contain a start date and time formatted per ISO 8601 standards (yyyy-MM-ddThh-mm-ss). Example input: ‘2014-11-05T23-00-00’ for 11/05/2014 at 11 p.m.Note: Always use ‘00’ for ‘ss’ (seconds). To maximize your application’s performance, FYI recommends that when you insert a time, whether through a system’s current time or otherwise, always round to the nearest 5 minute interval.

DurationstringOptional

Contains a value expressed in minutes that determines the amount of airing data returned in the response.

TimeZoneOffsetstringOptional

Contains a UTC offset value expressed in minutes that converts the response to a specific time zone. Example input: ‘-360’ for Central Standard Time.

ProgramDetailsbooleanOptional

Toggles on program details when true.

AiringDetailsbooleanOptional

Toggles Airing Details on and off within the intended response.

LineupDetailsbooleanOptional

Toggles Airing Details on and off within the intended response.

StationDetailsbooleanOptional

Toggles Airing Details on and off within the intended response.

ProgramTypestring · enumOptional

Contains either no value to return all Program Types, or one Program Type for a single filter

Possible values:
Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeListing

_ChannelNumberstringOptional
_DisplayCallSignstringOptional
_LineupDetailsSpecifiedbooleanOptional
_StationSpecifiedbooleanOptional
get
/StationListings

Returns information about available media and images for a station.

get

Returns information about available media and images for a station.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
StationIdstringRequired

Must contain a lookup value identifying a station.

MediaDetailsbooleanOptional

Toggles Media Details, such as available videos and images, on and off within the intended response.

OtherMediabooleanOptional

Toggles Other Media details on and off within the intended response.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeMediaAssets

get
/StationMedia

Returns linear schedule data associated to a one or more Sport Codes based on a specific timeframe and headend.

get

Returns linear schedule data associated to a one or more Sport Codes based on a specific timeframe and headend.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
HeadendIdstringRequired

Must contain a lookup value identifying a headend.

HeadendTypestring · enumRequired

Must contain a lookup enumerator that specifies the headend classification or distribution method.

Possible values:
StartDateTimestring · date-timeRequired

Must contain a start date and time formatted per ISO 8601 standards (yyyy-MM-ddThh-mm-ss). Example input: ‘2014-11-05T23-00-00’ for 11/05/2014 at 11 p.m.Note: Always use ‘00’ for ‘ss’ (seconds). To maximize your application’s performance, FYI recommends that when you insert a time, whether through a system’s current time or otherwise, always round to the nearest 5 minute interval.

DurationstringOptional

Contains a value expressed in minutes that determines the amount of airing data returned in the response.

TimeZoneOffsetstringOptional

Contains a UTC offset value expressed in minutes that converts the response to a specific time zone. Example input: ‘-360’ for Central Standard Time.

ProgramDetailsbooleanOptional

Toggles on program details when true.

AiringDetailsbooleanOptional

Toggles Airing Details on and off within the intended response.

LineupDetailsbooleanOptional

Toggles Airing Details on and off within the intended response.

StationDetailsbooleanOptional

Toggles Airing Details on and off within the intended response.

StationIdsstring[]Optional

Contains either no value to return all stations, a Station ID to return one station, or multiple Station IDs separated by commas to return many stations.

SportsCodestringOptional

Contains either no value to return all Sports Codes or one Sport Code for a single filter.

TeamIdstringOptional

Contains either no value to return all Teams, one Team ID for a single filter.

EventFilterstring[]Optional

Contains either no value to return all events, one value for a single event filter or multiple event values separated by commas for many filters

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeListing

_ChannelNumberstringOptional
_DisplayCallSignstringOptional
_LineupDetailsSpecifiedbooleanOptional
_StationSpecifiedbooleanOptional
get
/SportingEvents

Returns a list of one or more Sports Teams based on a specific city, state and/or Sports Code.

get

Returns a list of one or more Sports Teams based on a specific city, state and/or Sports Code.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
SportsCodestringOptional

Contains either no value to return all Sports Codes or one Sport Code for a single filter.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeSportsCategory

_ParentstringOptional
_CodestringOptional
_DescriptionstringOptional
get
/SportsCategories

Returns list of headends which serve a ZIP Code area.

get

Returns list of headends which serve a ZIP Code area.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
ZipCodestringRequired

Zip code of area to get providers for.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeProvider

_IDinteger · int32Optional
_NamestringOptional
_GMTOffsetinteger · int32Optional
_ObservesDSTbooleanOptional
_HeadendTypestringOptional
_HeadendTypeNamestringOptional
_HeadendDetailsSpecifiedbooleanOptional
_HeadendDetailsobjectOptional

Object

_ChannelLineupSpecifiedbooleanOptional
_ChannelLineupobject[]Optional

Object

get
/HeadendsByZip

Get Red Bee channel lineups for a given headend.

get

Get Red Bee channel lineups for a given headend.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
HeadendIdstringOptional
HeadendTypestringOptional
Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeChannelLineup

_ChannelNumberstringOptional
_DisplayCallSignstringOptional
_LineupDetailsSpecifiedbooleanOptional
_LineupDetailsobjectOptional

Object

_StationSpecifiedbooleanOptional
get
/HeadendChannelLineups

Get info about a headend.

get

Get info about a headend.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
HeadendIdstringRequired

ID of headend.

HeadendTypestringRequired

Headend type.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeHeadendInfo

_IDinteger · int32Optional
_NamestringOptional
_GMTOffsetinteger · int32Optional
_ObservesDSTbooleanOptional
_HeadendTypestringOptional
_HeadendTypeNamestringOptional
_HeadendDetailsSpecifiedbooleanOptional
_ChannelLineupSpecifiedbooleanOptional
_ChannelLineupobject[]Optional

Object

get
/HeadendInfo

Returns linear schedule data based on a specific timeframe and headend.

get

Returns linear schedule data based on a specific timeframe and headend.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
HeadendIdstringRequired

Must contain a lookup value identifying a headend.

HeadendTypestring · enumRequired

Must contain a lookup enumerator that specifies the headend classification or distribution method.

Possible values:
StartDateTimestring · date-timeRequired

Must contain a start date and time formatted per ISO 8601 standards (yyyy-MM-ddThh-mm-ss). Example input: ‘2014-11-05T23-00-00’ for 11/05/2014 at 11 p.m.Note: Always use ‘00’ for ‘ss’ (seconds). To maximize your application’s performance, FYI recommends that when you insert a time, whether through a system’s current time or otherwise, always round to the nearest 5 minute interval.

DurationstringOptional

Contains a value expressed in minutes that determines the amount of airing data returned in the response.

TimeZoneOffsetstringOptional

Contains a UTC offset value expressed in minutes that converts the response to a specific time zone. Example input: ‘-360’ for Central Standard Time.

ProgramDetailsbooleanOptional

Toggles on program details when true.

AiringDetailsbooleanOptional

Toggles Airing Details on and off within the intended response.

LineupDetailsbooleanOptional

Toggles Airing Details on and off within the intended response.

StationDetailsbooleanOptional

Toggles Airing Details on and off within the intended response.

ProgramTypestring · enumOptional

Contains either no value to return all Program Types, or one Program Type for a single filter

Possible values:
StationIdsstring[]Optional

Contains either no value to return all stations, a Station ID to return one station, or multiple Station IDs separated by commas to return many stations.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeListing

_ChannelNumberstringOptional
_DisplayCallSignstringOptional
_LineupDetailsSpecifiedbooleanOptional
_StationSpecifiedbooleanOptional
get
/HeadendListings

Returns a list of identifiers that are used to define a program’s subject matter based on the themes of audience, setting, format and content.

get

Returns a list of identifiers that are used to define a program’s subject matter based on the themes of audience, setting, format and content.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Query parameters
KeywordstringRequired

Must contain a URL-encoded keyword parameter used to search for a category description.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeCategory

_CodestringOptional
_DescriptionstringOptional
_ParentstringOptional
get
/RedBeeCategories

Returns a list of identifiers that are used to define a program’s subject matter based on a single generalized theme.

get

Returns a list of identifiers that are used to define a program’s subject matter based on a single generalized theme.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeGenre

_CodestringOptional
_DescriptionstringOptional
get
/RedBeeGenres

Returns an enumerated list of language codes that may be assigned to programs, airings or stations.

get

Returns an enumerated list of language codes that may be assigned to programs, airings or stations.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeLanguage

_CodestringOptional
_DescriptionstringOptional
_ParentstringOptional
get
/RedBeeLanguages

Returns a list of parental guidelines that can be used to block offensive broadcasts from unintended audiences.

get

Returns a list of parental guidelines that can be used to block offensive broadcasts from unintended audiences.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeTVRating

_DescstringOptional
_CodestringOptional
_ExplanationCodesstringOptional
get
/RedBeeTVRatings

Returns a list of values that are used to warn viewers of specific content within a parental guideline.

get

Returns a list of values that are used to warn viewers of specific content within a parental guideline.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeTVRatingExplanation

_CodestringOptional
_DescriptionstringOptional
get
/RedBeeTVRatingsExplanations

Returns a list of values governed by the Motion Picture Association of America that identify a film’s intended audience.

get

Returns a list of values governed by the Motion Picture Association of America that identify a film’s intended audience.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeMPAARating

_CodestringOptional
_DescriptionstringOptional
get
/RedBeeMPAARatings

Returns a list of values that are used to provide viewers an explanation of programming content.

get

Returns a list of values that are used to provide viewers an explanation of programming content.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeMPAARatingExplanation

_CodestringOptional
_DescriptionstringOptional
get
/RedBeeMPAARatingsExplanations

Returns a list of values that categorize a fact associated to a database value.

get

Returns a list of values that categorize a fact associated to a database value.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeFactType

_IDstringOptional
_NamestringOptional
_DescriptionstringOptional
get
/RedBeeFactTypes

Get list of Red Bee channel types.

get

Get list of Red Bee channel types.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeChannelType

_CodestringOptional
_DescriptionstringOptional
get
/RedBeeChannelTypes

Returns a list of values that are used to designate the classification of program.

get

Returns a list of values that are used to designate the classification of program.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeProgramType

_CodestringOptional
_DescriptionstringOptional
get
/RedBeeProgramTypes

Get list of Red Bee headend types.

get

Get list of Red Bee headend types.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeHeadendType

_NamestringOptional
_CodestringOptional
_DescriptionstringOptional
get
/RedBeeHeadendTypes

Returns a list of values that are used to demonstrate an entity’s association to a program.

get

Returns a list of values that are used to demonstrate an entity’s association to a program.

Authorizations
Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
chevron-right
200

OK.

RedBeeRoleType

_NamestringOptional
_DescriptionstringOptional
get
/RedBeeRoleTypes

Last updated