Data: ns2
- Namespace: http://videoscape.cisco.com/epg/webservices
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:
- Blackout
- BlackoutMetadata
- BlackoutSchedule
- ChannelMap
- ChannelMapNumber
- Genre
- PageInfoAdapter
- ProcessStatus
- ProcessStepStatus
- Program
- ProgramContributor
- ProgramCustomField
- ProgramGenre
- ProgramId
- ProgramImage
- ProgramMetadata
- Region
- Schedule
- ScheduleCorrection
- ScheduleCorrectionMetadata
- ScheduleCustomField
- ScheduleMetadata
- SortField
- Station
- StationCustomField
- StationGenre
- StationImage
- WorkflowMessage
- WorkflowStatus
Type Blackout
Blackout entity bean.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
blackoutPk (int) | 0/1 | (no documentation provided) |
deleted (boolean) | 0/1 | (no documentation provided) |
station (int) | 0/1 | (no documentation provided) |
substitutionStation (int) | 0/1 | (no documentation provided) |
substitutionUnmanagedUrl (string) | 0/1 | (no documentation provided) |
createdDate (dateTime) | 0/1 | (no documentation provided) |
modifiedDate (dateTime) | 0/1 | (no documentation provided) |
BlackoutSchedules/BlackoutSchedule (BlackoutSchedule) | 0/unbounded | (no documentation provided) |
regions (int) | 0/unbounded | (no documentation provided) |
BlackoutMetadatas/BlackoutMetadata (BlackoutMetadata) | 0/unbounded | (no documentation provided) |
Type BlackoutMetadata
- Extends: abstractMetadata
Blackout entity bean.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
blackoutMetadataPk (int) | 0/1 | (no documentation provided) |
name (string) | 0/1 | (no documentation provided) |
description (string) | 0/1 | (no documentation provided) |
Type BlackoutSchedule
BlackoutSchedule entity bean.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
blackoutSchedulePk (int) | 0/1 | (no documentation provided) |
startDate (dateTime) | 0/1 | (no documentation provided) |
endDate (dateTime) | 0/1 | (no documentation provided) |
duration (int) | 0/1 | (no documentation provided) |
deleted (boolean) | 0/1 | (no documentation provided) |
Type ChannelMap
ChannelMap entity bean. Defines station mapping in some region. Contains references to region and station, set of channel numbers on whichstation is broadcasted. Can also contain overrides for station external id and call sign - channel map external id and label.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
channelMapPk (int) | 0/1 | Gets the primary key of the ChannelMap. |
station (int) | 0/1 | Gets the Station associated with this ChannelMap. |
externalId (string) | 0/1 | Gets the ChannelMap's external id. |
label (string) | 0/1 | Gets the ChannelMap's label. |
ChannelNumbers (ChannelMapNumber) | 0/unbounded | Gets the set of channel numbers associated with this ChannelMap. |
Type ChannelMapNumber
ChannelMap number entity bean. Contains number of channel and channel active window.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
channelNumberPk (int) | 0/1 | (no documentation provided) |
channelNumber (int) | 0/1 | (no documentation provided) |
startDate (dateTime) | 0/1 | (no documentation provided) |
endDate (dateTime) | 0/1 | (no documentation provided) |
isNew (boolean) | 0/1 | (no documentation provided) |
Type Genre
Genre entity class.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
name (string) | 0/1 | Gets the name. |
code (string) | 0/1 | Gets the code. |
locale (int) | 0/1 | Gets the locale. |
Type PageInfoAdapter
Class PageInfoAdapter is used as a parameter for web services. SOAP web services unable to use PageInfo as a parameter due to lack of settersfor its fields and because it uses java.util.Map to describe sort fields. PageInfoAdapter uses Set<SortField> instead of java.util.Map.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
count (int) | 0/1 | Retrieve the count for page. |
SortFields (SortField) | 0/unbounded | Retrieve collection of SortFields describing page order. |
startNum (int) | 0/1 | Retrieve start reference for page. |
Type ProcessStatus
Process status entity.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
processStatusPk (int) | 0/1 | Gets primary key. |
workflowStatus (int) | 0/1 | Gets workflowStatus. |
processId (string) | 0/1 | Gets the process identifier. |
State (operationState) | 0/1 | Gets the operation state. |
type (string) | 0/1 | Gets the process status type. |
startDate (dateTime) | 0/1 | Gets process start date. |
endDate (dateTime) | 0/1 | Gets process end date. |
ProcessStepStatuses (ProcessStepStatus) | 0/unbounded | Gets process step status. |
Type ProcessStepStatus
Process step status entity.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
processStepStatusPk (int) | 0/1 | Gets primary key. |
State (operationState) | 0/1 | Gets the operation state. |
type (string) | 0/1 | Gets the process status type. |
startDate (dateTime) | 0/1 | Gets process start date. |
endDate (dateTime) | 0/1 | Gets process end date. |
nodeId (string) | 0/1 | Gets node identifier. |
threadId (string) | 0/1 | Gets thread identifier. |
processed (int) | 0/1 | Gets quantity of processed elements. |
total (int) | 0/1 | Gets total quantity of elements. |
processStatus (int) | 0/1 | Gets process statuses. |
Type Program
- Extends: abstractProgramCore
Program entity bean.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
programPk (int) | 0/1 | Gets the primary key of the program. |
externalId (string) | 0/1 | Gets the external id of the program. |
modifiedDate (dateTime) | 0/1 | Gets the last time the program was modified. |
programType (string) | 0/1 | Gets type of the program. |
subType (programSubType) | 0/1 | Gets subtype ProgramSubType for this program. |
year (int) | 0/1 | Gets the program's year. |
originalAirDate (string) | 0/1 | Property for web-service support old clients. |
popularityRating (double) | 0/1 | Gets program's popularity rating of the program. |
animatedFlag (boolean) | 0/1 | Gets a program's animated flag value. |
blackWhiteFlag (boolean) | 0/1 | Gets a program's black white flag value. |
sportsFlag (boolean) | 0/1 | Gets a program's sports flag value. |
madeForTv (boolean) | 0/1 | Gets a program's made for tv flag value. |
duration (int) | 0/1 | Gets a program's duration. |
lockedFlag (boolean) | 0/1 | Gets a program's locked flag value. |
ProgramGenres/ProgramGenre (ProgramGenre) | 0/unbounded | Gets a program's set of ProgramGenre. |
ProgramImages/ProgramImage (ProgramImage) | 0/unbounded | Gets a program's set of ProgramImage. |
ProgramIds/ProgramId (ProgramId) | 0/unbounded | Gets a program's set of ProgramId. |
ProgramContributors/ProgramContributor (ProgramContributor) | 0/unbounded | Gets a program's set of ProgramContributor. |
ProgramCustomFields/ProgramCustomField (ProgramCustomField) | 0/unbounded | Gets a program's set of ProgramCustomField. |
ProgramMetadatas/ProgramMetadata (ProgramMetadata) | 0/unbounded | Gets a program's set of ProgramMetadata. |
Type ProgramContributor
ProgramContributor entity bean. Mapping entity between Program and Contributor.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
programContributorPk (int) | 0/1 | Gets the primary key of the ProgramContributor. |
contributor (int) | 0/1 | Gets the Contributor. |
rank (int) | 0/1 | Gets rank of the ProgramContributor. |
modifiedDate (dateTime) | 0/1 | Gets modified date of the ProgramContributor. |
Type ProgramCustomField
- Extends: searchableCustomField
ProgramCustomField entity bean.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
programCustomPk (int) | 0/1 | Gets primary key of the ProgramCustomField. |
locale (int) | 0/1 | Gets Locale. |
modifiedDate (dateTime) | 0/1 | Gets modified date of the ProgramCustomField. |
isTstv (boolean) | 0/1 | Retrieves TSTV flag value for current custom field. All TSTV custom fields will go to REDERED_XML in CaptureSchedule. |
Type ProgramGenre
ProgramGenre entity bean. Mapping entity between Program and Genre.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
programGenrePk (int) | 0/1 | Gets primary key. |
genre (int) | 0/1 | Gets entity Genre. |
modifiedDate (dateTime) | 0/1 | Gets date-time of entity's last modification. |
Type ProgramId
ProgramId entity bean. Similar to custom field as represents name-value pair but has specific purpose - intended to store program additionalidentifiers.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
programIdPk (int) | 0/1 | Gets primary key. |
name (string) | 0/1 | Gets name of Program addition identifier. |
value (string) | 0/1 | Gets value of addition identifier for Program. |
Type ProgramImage
- Extends: image
ProgramImage entity bean. Represents Program image with core fields (uri, width, height) and field specific to program image - category.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
programImagePk (int) | 0/1 | Gets primary key. |
category (string) | 0/1 | Gets category of image. |
tier (string) | 0/1 | Gets tier of an image. |
modifiedDate (dateTime) | 0/1 | Gets date-time of entity's last modification. |
mimeType (string) | 0/1 | Gets MIME type of image. |
caption (string) | 0/1 | Gets caption for image. |
assetClassification (string) | 0/1 | Gets asset classification for image. |
locale (int) | 0/1 | Gets Locale. |
localeString (string) | 0/1 | (no documentation provided) |
Type ProgramMetadata
- Extends: abstractMetadataCore
ProgramMetadata entity bean.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
programMetadataPk (int) | 0/1 | Gets primary key. |
longTitle (string) | 0/1 | Gets long title. |
mediumDescription (string) | 0/1 | Gets medium description. |
longDescription (string) | 0/1 | Gets long description. |
language (string) | 0/1 | Gets language. |
country (string) | 0/1 | Gets country. |
advisories (string) | 0/1 | Gets advisories. |
keywords (string) | 0/1 | Gets keywords related to program. |
Type Region
Region entity bean. Contains descriptive information about region.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
regionPk (int) | 0/1 | Gets entity PK |
active (boolean) | 0/1 | Gets value of property "active" |
name (string) | 0/1 | Gets value of property "name" |
externalId (string) | 0/1 | Gets value of property "externalId" |
description (string) | 0/1 | Gets value of property "description" |
areaServed (string) | 0/1 | Gets value of property "areaServed" |
rangeZipCodes (string) | 0/1 | Gets value of property "rangeZipCodes" |
rangeIPs (string) | 0/1 | Gets value of property "rangeIPs" |
createdDate (dateTime) | 0/1 | System field. Is set automatically. |
modifiedDate (dateTime) | 0/1 | System field. Is set automatically. |
ChannelMaps (ChannelMap) | 0/unbounded | Gets value of property "channelMaps" |
timeZone (string) | 0/1 | Gets value of property "timeZone" |
location (string) | 0/1 | Gets value of property "location" |
system (string) | 0/1 | Gets value of property "system" |
deviceType (string) | 0/1 | Gets value of property "deviceType" |
locked (boolean) | 0/1 | Gets value of property "locked" |
groupId (string) | 0/1 | Gets value of property "groupId" |
Type Schedule
- Extends: abstractProgramCore
Schedule entity bean. Represents schedule information like schedule start/end dates, duration, titles, flags, etc.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
schedulePk (int) | 0/1 | Retrieves primary key for current schedule. |
station (int) | 0/1 | Retrieves related Station instance for current schedule. |
program (int) | 0/1 | Retrieves related Program instance for current schedule. |
published (boolean) | 0/1 | Retrieves published flag for current schedule. |
toDelete (boolean) | 0/1 | Retrieves to-delete flag for current schedule. |
new (boolean) | 0/1 | Retrieves isNew flag for current schedule. |
programExternalId (string) | 0/1 | Retrieves the external ID of related program. |
startDate (dateTime) | 0/1 | Retrieves start time of related program. |
endDate (dateTime) | 0/1 | Retrieves end time for scheduled program. |
duration (int) | 0/1 | Retrieves duration of scheduled program. |
rerunFlag (boolean) | 0/1 | Retrieves rerun flag value for scheduled program. |
liveFlag (boolean) | 0/1 | Retrieves live flag value for scheduled program. |
stereoFlag (boolean) | 0/1 | Retrieves stereo flag value for scheduled program. |
sapFlag (boolean) | 0/1 | Retrieves SAP flag value for scheduled program. |
surroundFlag (boolean) | 0/1 | Retrieves surround flag for scheduled program. |
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 | Retrieves captioned flag for scheduled program. |
subtitledFlag (boolean) | 0/1 | Retrieves subtitled flag for scheduled program. |
hdFlag (boolean) | 0/1 | Retrieves HD flag for scheduled program. |
uhdFlag (boolean) | 0/1 | Retrieves Ultra HD flag for scheduled program. |
threeDFlag (boolean) | 0/1 | Retrieves 3D flag for scheduled program. |
widescreenFlag (boolean) | 0/1 | Retrieves wide-screen flag for scheduled program. |
coarseLangFlag (boolean) | 0/1 | Retrieves coarse language flag for scheduled program. |
violenceFlag (boolean) | 0/1 | Retrieves violence flag for scheduled program. |
dialogFlag (boolean) | 0/1 | Retrieves dialog flag for scheduled program. |
fantasyViolenceFlag (boolean) | 0/1 | Retrieves fantasy violence flag for scheduled program. |
firstShowFlag (boolean) | 0/1 | Retrieves first show flag for scheduled program. |
lastShowFlag (boolean) | 0/1 | Retrieves last show flag for scheduled program. |
dvsFlag (boolean) | 0/1 | Retrieves DVS flag for scheduled program. |
modifiedDate (dateTime) | 0/1 | Retrieves last modified date for current schedule. |
programAirDate (string) | 0/1 | Property for web-service support old clients. |
ScheduleCustomFields/ScheduleCustomField (ScheduleCustomField) | 0/unbounded | Retrieves list with related ScheduleCustomField instances. |
ScheduleMetadatas/ScheduleMetadata (ScheduleMetadata) | 0/unbounded | Retrieves related ScheduleMetadata set for current schedule. |
subtitleLanguages (string) | 0/1 | Retrieves available subtitle languages for scheduled program. |
externalEventId (string) | 0/1 | Gets external event id that EPG providers maintain and that remains consistent between feeds updates. |
Type ScheduleCorrection
- Extends: scheduleCore
Schedule corrections entity bean.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
scheduleCorrectionPk (int) | 0/1 | (no documentation provided) |
startDate (dateTime) | 0/1 | Gets start date of schedule correction. |
endDate (dateTime) | 0/1 | Gets end date of schedule correction. |
program (int) | 0/1 | Gets the program related to schedule correction. |
station (int) | 0/1 | Gets the station related to schedule correction. |
createdDate (dateTime) | 0/1 | Gets the date when schedule correction was created. |
modifiedDate (dateTime) | 0/1 | Gets the date when modified date of schedule correction was modified. |
isDeleted (boolean) | 0/1 | Verify if schedule correction is deleted. |
ScheduleCorrectionMetadatas/ScheduleCorrectionMetadata (ScheduleCorrectionMetadata) | 0/unbounded | Gets the set of metadatas related to schedule correction. |
Type ScheduleCorrectionMetadata
- Extends: abstractMetadata
Schedule correction metadata entity bean.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
scheduleCorrectionMetadataPk (int) | 0/1 | Gets the PK of schedule correction metadata. |
sapLanguage (string) | 0/1 | Gets the sap language of schedule correction metadata. |
dubbedLanguage (string) | 0/1 | Gets the dubbed language of schedule correction metadata. |
Type ScheduleCustomField
- Extends: customField
ScheduleCustomField entity bean.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
scheduleCustomPk (int) | 0/1 | (no documentation provided) |
locale (locale) | 0/1 | Gets the locale related to schedule custom field. |
modifiedDate (dateTime) | 0/1 | Gets the modified date of schedule custom field. |
isTstv (boolean) | 0/1 | Retrieves TSTV flag value for current custom field. All TSTV custom fields will go to REDERED_XML in CaptureSchedule. |
Type ScheduleMetadata
- Extends: abstractMetadataCore
Schedule metadata entity bean.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
scheduleMetadataPk (int) | 0/1 | Get schedule metadata primary key. |
genres (string) | 0/1 | Get comma separated genres list of schedule metadata. |
sapLanguage (string) | 0/1 | Get SAP language of schedule metadata. |
dubbedLanguage (string) | 0/1 | Get dubbed language of schedule metadata. |
programImages (string) | 0/1 | Get program images binary object of schedule metadata. |
Type SortField
- Extends: SortField
Class SortField is used for creating set of sort fields in class PageInfoAdapter.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
SortFieldName (string) | 0/1 | (no documentation provided) |
Type Station
Programming Service entity bean. Contains descriptive information for EPG Programming Service.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
stationPk (int) | 0/1 | Gets the primary key of the Programming Service. |
active (boolean) | 0/1 | Gets the Programming Service activeness. |
externalId (string) | 0/1 | Gets the Programming Service identifier from external provider. |
callSign (string) | 0/1 | Gets the Programming Service call sign. |
name (string) | 0/1 | Gets the Programming Service name. |
language (string) | 0/1 | Gets the Programming Service broadcast language code. |
timezone (string) | 0/1 | Gets the Programming Service time zone. |
affiliation (string) | 0/1 | Gets Programming Service associated network, cable or broadcasting group. |
url (string) | 0/1 | Gets Programming Service URL. |
type (string) | 0/1 | Gets Programming Service type. See provider documentation for a list of Programming Service type values. |
modifiedDate (dateTime) | 0/1 | Gets the last time the station was modified. |
StationImages (StationImage) | 0/unbounded | Gets the Programming Service images. |
StationCustomFields (StationCustomField) | 0/unbounded | Gets the Programming Service custom fields. |
StationGenres (StationGenre) | 0/unbounded | Gets the Programming Service genres. |
stationSources (stationSource) | 0/unbounded | Gets the Programming Service station sources. |
Type StationCustomField
- Extends: searchableCustomField
Programming Service Custom Field entity bean.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
stationCustomPk (int) | 0/1 | Gets the primary key of the Programming Service Custom Field. |
Type StationGenre
Programming Service Genre entity bean.Mapping entity between Station and Genre.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
stationGenrePk (int) | 0/1 | Gets the primary key of the Programming Service Genre. |
genre (int) | 0/1 | Gets the Genre associated with the Programming Service Genre. |
Type StationImage
- Extends: image
Programming Service Image entity bean.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
stationImagePk (int) | 0/1 | Gets the primary key of the Programming Service Image. |
primaryFlag (boolean) | 0/1 | Gets the Programming Service Image primary flag. |
defaultFlag (boolean) | 0/1 | Gets the Programming Service Image default flag. |
Type WorkflowMessage
Process step error entity.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
workflowMessagePk (int) | 0/1 | Gets primary key. |
workflowStatus (int) | 0/1 | Gets workflowStatus. |
message (string) | 0/1 | Gets message. |
eventTime (dateTime) | 0/1 | Gets event time.The following basic validation is performed on the incoming data:
|
severity (workflowMessageSeverity) | 0/1 | Gets workflow message severity. |
Type WorkflowStatus
Workflow status entity.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
workflowStatusPk (int) | 0/1 | Gets primary key. |
workflowUUID (string) | 0/1 | Gets workflow UUID. |
State (operationState) | 0/1 | Gets the operation state. |
startDate (dateTime) | 0/1 | Gets process start date. |
endDate (dateTime) | 0/1 | Gets process end date. |
heartbeat (long) | 0/1 | Gets heartbeat for current workflow. |
currentProcessStatus (int) | 0/1 | Gets current process step status. |
ProcessStatuses (ProcessStatus) | 0/unbounded | Gets process statuses. |