Data

  • Default Namespace

The data in this namespace is divided into elements and types. Types define the structure of the data. Elements define specific instances of the types, and are therefore more relevant to REST endpoints, which generally consume and/or produce elements.

The following types are members of this namespace:

Type abstractMetadata

Base class for entities containing metadata information.

Child Elements

name (type) min/max
occurs
description
locale (int) 0/1 (no documentation provided)
createdDate (dateTime) 0/1 (no documentation provided)
modifiedDate (dateTime) 0/1 (no documentation provided)

Type abstractMetadataCore

Base class for entities containing metadata information.

Child Elements

name (type) min/max
occurs
description
shortTitle (string) 0/1 (no documentation provided)
mediumTitle (string) 0/1 (no documentation provided)
episodeTitle (string) 0/1 (no documentation provided)
shortDescription (string) 0/1 (no documentation provided)
captionLanguage (string) 0/1 (no documentation provided)
signLanguage (string) 0/1 (no documentation provided)
seriesDescription (string) 0/1 (no documentation provided)

Type abstractProgramCore

Base class for entities containing program information.

Child Elements

name (type) min/max
occurs
description
seriesExternalId (string) 0/1 (no documentation provided)
seasonExternalId (string) 0/1 (no documentation provided)
seasonNumber (int) 0/1 (no documentation provided)
episodeNumber (int) 0/1 (no documentation provided)
episodeSynNumber (string) 0/1 (no documentation provided)
episodeAltSynNumber (string) 0/1 (no documentation provided)
mpaaRating (string) 0/1 (no documentation provided)
tvRating (string) 0/1 (no documentation provided)
kidsFlag (boolean) 0/1 (no documentation provided)
adultFlag (boolean) 0/1 (no documentation provided)
movieFlag (boolean) 0/1 (no documentation provided)
eroticFlag (boolean) 0/1 (no documentation provided)

Type action

Action responsible for action with CaptureScheduleNotificationQueue. 0 means "add", 1 - delete.Ordinal enumeration type was applied so values in database will be provided with numeric sequence as it is in enum.

Possible Values

value description
ADD
DELETE

Type captureSchedule

CaptureSchedule entity bean.

Child Elements

name (type) min/max
occurs
description
captureSchedulePk (int) 0/1 (no documentation provided)
contentId (string) 0/1 (no documentation provided)
stationSourceId (string) 0/1 (no documentation provided)
programExternalId (string) 0/1 (no documentation provided)
startDate (dateTime) 0/1 (no documentation provided)
endDate (dateTime) 0/1 (no documentation provided)
processed (boolean) 0/1 (no documentation provided)
published (boolean) 0/1 (no documentation provided)
rendered (string) 0/1 (no documentation provided)
version (long) 0/1 (no documentation provided)
captureScheduleNotificationQueues (captureScheduleNotificationQueue) 0/unbounded (no documentation provided)
captureScheduleKeysetInfos (captureScheduleKeysetInfo) 0/unbounded (no documentation provided)

Type captureScheduleKeysetInfo

Capture schedule keyset info entity bean

Child Elements

name (type) min/max
occurs
description
captureScheduleKeysetInfoPk (int) 0/1 (no documentation provided)
captureSetting (captureSetting) 0/1 (no documentation provided)
captureSchedule (captureSchedule) 0/1 (no documentation provided)
keysetTemplateId (string) 0/1 (no documentation provided)
keysetId (string) 0/1 (no documentation provided)
keysetAttributes (string) 0/1 (no documentation provided)
drmType (string) 0/1 (no documentation provided)

Type captureScheduleNotificationQueue

CaptureScheduleNotificationQueue entity bean.

Child Elements

name (type) min/max
occurs
description
queueId (int) 0/1 Gets the primary key of the CaptureScheduleNotificationQueue.
captureSchedule (captureSchedule) 0/1 Gets the CaptureSchedule associated with this CaptureScheduleNotificationQueue.

We don't have foreign key constraint in DB because we might have DELETE action for already removed CaptureSchedule in the queue.

contentId (string) 0/1 Gets the CaptureScheduleNotificationQueue's content id.
stationSourceId (string) 0/1 Gets the CaptureScheduleNotificationQueue's station source id.
action (action) 0/1 Gets the Action enum associated with this CaptureScheduleNotificationQueue.
programExternalId (string) 0/1 Gets the CaptureScheduleNotificationQueue's program external id.
startDate (dateTime) 0/1 Gets the CaptureScheduleNotificationQueue's start date.
endDate (dateTime) 0/1 Gets the CaptureScheduleNotificationQueue's end date.
createDate (dateTime) 0/1 Gets the CaptureScheduleNotificationQueue's create date.
version (long) 0/1 Gets the CaptureScheduleNotificationQueue's version.

Type captureSetting

Capture Setting entity bean

Child Elements

name (type) min/max
occurs
description
captureSettingPk (int) 0/1 Gets the primary key of the CaptureSetting.
deviceProfileId (string) 0/1 Gets the CaptureSetting's device profile id.
keysetTemplateId (string) 0/1 Gets the CaptureSetting's keyset template id.
keysetId (string) 0/1 Gets the CaptureSetting's keyset id.
captureSource (string) 0/1 Gets the CaptureSetting's capture source.
stationSource (stationSource) 0/1 Gets the StationSource associated with this CaptureSetting.
sourceLevel (boolean) 0/1 Gets the value of flag which identify if this CaptureSetting is active on station source level.
recordingsWithIgnoredSetting (stationSourceRecording) 0/unbounded Gets the set of recordings with ignored setting associated with this CaptureSetting.
recordingsWithAdditionalSetting (stationSourceRecording) 0/unbounded Gets the set of recordings with additional setting associated with this CaptureSetting.
captureScheduleKeysetInfos (captureScheduleKeysetInfo) 0/unbounded Gets the set of capture schedule keyset info associated with this CaptureSetting.

Type customField

Base class for custom field entities. Contains core custom field properties.

Child Elements

name (type) min/max
occurs
description
name (string) 0/1 (no documentation provided)
value (string) 0/1 (no documentation provided)

Type customFieldType

Constants represent available types for custom fields.

Possible Values

value description
DATE Represents date type.
NUMERIC Represents numeric type.
TEXT Represents text type.

Type image

Base class for image entities.

Child Elements

name (type) min/max
occurs
description
width (int) 0/1 Gets the width.
height (int) 0/1 Gets the height.
uri (string) 0/1 Gets the uri.

Type locale

Locale entity class.

Child Elements

name (type) min/max
occurs
description
localePk (int) 0/1 Gets the locale pk.
language (string) 0/1 Gets the language.
country (string) 0/1 Gets the country.

Type operationState

Enum for Workflow/Process state.

Possible Values

value description
COMPLETE Status for successfully completed operation.
COMPLETE_WITH_WARNINGS Status for completed operation with warnings.
IN_PROGRESS Status for in progress operation.
ERROR Status for operation completed with error.
TERMINATED Status for operation terminated.
ALL Either COMPLETE, IN_PROGRESS or ERROR.

Type policy

TSTV Policy entity bean

Child Elements

name (type) min/max
occurs
description
policyPk (int) 0/1 Gets the primary key of the Policy.
uuid (string) 0/1 Gets the UUID of the Policy.
name (string) 0/1 Gets name of the Policy.
description (string) 0/1 Gets description of the Policy.
programPolicyFlag (boolean) 0/1 Gets the value of flag which identify if this Policy is a program policy.
startOverEnabled (boolean) 0/1 Gets the value of flag which identify if start_over is enabled in Policy.
livePauseEnabled (boolean) 0/1 Gets the value of flag which identify if Live TV Pause is enabled in Policy.
liveTrickPlay (string) 0/1 Gets the live_trick_play value of the Policy.
revEpgTrickPlay (string) 0/1 Gets the rev_epg_trick_play value of the Policy.
catchupTrickPlay (string) 0/1 Gets the catchup_trick_play value of the Policy.
availabilityWindow (int) 0/1 Gets availability window of the Policy.
revEpgEnabled (boolean) 0/1 Gets the value of flag which identify if Reverse EPG is enabled in Policy.
revEpgExpiry (int) 0/1 Gets rev_epg_expiry value of the Policy.
catchupEnabled (boolean) 0/1 Gets the value of flag which identify if Catch-up TV is enabled in Policy.
catchupExpiry (int) 0/1 Gets Catch-up TV Expires value in Policy.
leadTime (int) 0/1 Gets lead time value of the Policy.
trailTime (int) 0/1 Gets trail time value of the Policy.
uniqueTimeRecording (boolean) 0/1 Gets the value of flag which identify if unique time recording is enabled in Policy.
active (boolean) 0/1 Gets the value of flag which identify if Policy is active.
modifiedDate (dateTime) 0/1 Gets date when Policy was last modified.
stationSources (stationSource) 0/unbounded Gets the StationSource's associated with this Policy.

Type programRecording

Station Source entity bean

Child Elements

name (type) min/max
occurs
description
programRecordingPk (int) 0/1 Gets the primary key associated with this ProgramRecording.
name (string) 0/1 Gets the name associated with this ProgramRecording.
description (string) 0/1 Gets the description associated with this ProgramRecording.
externalId (string) 0/1 Gets the external Id associated with this ProgramRecording.
programLevel (boolean) 0/1 Gets if is active program level of ProgramRecording.
active (boolean) 0/1 Returns if this ProgramRecording is active.
modifiedDate (dateTime) 0/1 Gets the Date associated with this ProgramRecording.
policy (policy) 0/1 Sets the Policy associated with this ProgramRecording.
stationSourceRecordings (stationSourceRecording) 0/unbounded Gets a set of StationSourceRecordings associated with this ProgramRecording.

Type programSubType

Listing of possible Program subtypes.

Possible Values

value description
SINGLE Represents any standard Program (Movie, Episode, Sport Event, etc) that is NOT a container for other Programs and has associated schedule events.
SEASON Group (container) for Programs with subType=SINGLE, can't have any schedule events by design.
SHOW Group (container) for Programs with subType=SEASON, can't have any schedule events by design.

Type scheduleCore

Base class for entities containing schedule information.

Child Elements

name (type) min/max
occurs
description
rerunFlag (boolean) 0/1 Indicates if program is rerun.
liveFlag (boolean) 0/1 Indicates if program is live broadcast.
stereoFlag (boolean) 0/1 Indicates an event is being broadcast in stereo.
sapFlag (boolean) 0/1 Indicates the availability of Secondary Audio Programming (SAP).
surroundFlag (boolean) 0/1 Indicates if program is in dolby.
dolbyProLogicFlag (boolean) 0/1 Retrieves Dolby Pro Logic flag for scheduled program.
dolbyDigitalFlag (boolean) 0/1 Retrieves Dolby Digital flag for scheduled program.
dolby51Flag (boolean) 0/1 Retrieves Dolby 5.1 flag for scheduled program.
captionedFlag (boolean) 0/1 Indicates Closed Captioning: Spoken content of program is listed on screen for the hearing-impaired.
subtitledFlag (boolean) 0/1 Indicates if program is subtitled.
hdFlag (boolean) 0/1 Indicates whether a program is available in High Definition TV.
uhdFlag (boolean) 0/1 Retrieves Ultra HD flag for scheduled program.
threeDFlag (boolean) 0/1 Indicates program is in 3-D.
widescreenFlag (boolean) 0/1 Indicates program is a letterbox version.
coarseLangFlag (boolean) 0/1 Gets the coarse lang field value.
violenceFlag (boolean) 0/1 Gets the violence flag field value.
dialogFlag (boolean) 0/1 Gets the value of dialog flag value.
fantasyViolenceFlag (boolean) 0/1 Gets the value of fantasy violence flag.
firstShowFlag (boolean) 0/1 Indicates if program is shown first time.
lastShowFlag (boolean) 0/1 Indicates if program is shown last time.
dvsFlag (boolean) 0/1 Indicates a program with Descriptive Video Service (DVS).
externalEventId (string) 0/1 Gets external event id that EPG providers maintain and that remains consistent between feeds updates.

Type searchableCustomField

Base class for searchable custom fields.

Child Elements

name (type) min/max
occurs
description
searchable (boolean) 0/1 Retrieves searchable field value for current custom field.
searchFieldType (customFieldType) 0/1 Retrieves search field type for current custom field. Should be one from CustomFieldType enumeration.

Type stationSource

Programming Service Source entity bean.

Programming Service Source is a representation of the service that captures TSTV content.

Child Elements

name (type) min/max
occurs
description
stationSourcePk (int) 0/1 Gets the primary key of the Programming Service source.
active (boolean) 0/1 Gets the Programming Service Source activeness.
name (string) 0/1 Gets the Programming Service Source name.
srdn (string) 0/1 Gets the Programming Service Source Service Routing Domain Name (SRDN), that represents location of the capture source.
channelName (string) 0/1 Gets the Programming Service Source channel name within the SRDN context.
stationSourceId (string) 0/1 Gets the Programming Service Source randomly generated hash code.
station (Station) 0/1 Gets the Programming Service associated with the Programming Service Source.
policy (policy) 0/1 Gets the Policy associated with the Programming Service Source.
captureSettings (captureSetting) 0/unbounded Gets the Capture Settings associated with the Programming Service Source.
stationSourceRecordings (stationSourceRecording) 0/unbounded Gets the Programming Service Source Recording associated with the Programming Service Source.
channelMaps (ChannelMap) 0/unbounded Gets the lineups associated with the Programming Service Source.
modifiedDate (dateTime) 0/1 Gets the Programming Service Source last modified date.

Type stationSourceRecording

Station Source Recording entity bean.

Child Elements

name (type) min/max
occurs
description
stationSourceRecordingPk (int) 0/1 Get station source recording primary key.
stationSource (stationSource) 0/1 Get station source of station source recording.
programRecording (programRecording) 0/1 Get program recording of station source recording.
captureSettingsIgnored (captureSetting) 0/unbounded Get collection of ignored capture settings of station source recording.
captureSettingsAdditional (captureSetting) 0/unbounded Get collection of additional capture settings of station source recording.

Type StringMap

Child Elements

name (type) min/max
occurs
description
entry (ValueEntry) 0/unbounded (no documentation provided)

Type ValueEntry

Child Elements

name (type) min/max
occurs
description
key (string) 1/1 (no documentation provided)
value (string) 0/1 (no documentation provided)

Type workflowMessageSeverity

Enumerator representing acceptable severity types for worklow messages.

Possible Values

value description
ERROR For severity Error.
WARNING For severity Warning.
INFO For severity Info.