ProgramService

Endpoint Metadata

  • Namespace: http://videoscape.cisco.com/epg/webservices/program
  • Endpoint Name: ProgramWebService
  • Endpoint Address: http(s)://{VMS URL}/LinearManager/webservices/program-service

The following methods are available on this endpoint:

createProgram

Create and persist a new program. Program is linked to following related data collections: program genres, images, identifiers,contributors and custom fields.

Creation is terminated if EPG workflow is currently in progress.

Input Parameters

name type description
program Program Program to be created.

Return Value

type description
Program Return persisted program.

Faults

name description
ProgramWebServiceFault Thrown if any exception is encountered.

findPrograms

This method has been deprecated. Deprecated as of 5.7.1, replaced by ProgramWebService#findProgramsList(String, PageInfoAdapter, ProgramSubType).

Input Parameters

name type description
searchTerm string (no documentation provided)
pageInfoAdapter PageInfoAdapter (no documentation provided)

Return Value

type description
list<Program> (no documentation provided)

Faults

name description
ProgramWebServiceFault (no documentation provided)

findProgramsList

Retrieve a paged list of programs containing searchTerm.

Input Parameters

name type description
searchTerm string Text searched for in a program's short title, episode title or external identifier. If null or empty, all programs are returned.
pageInfoAdapter PageInfoAdapter Page settings for result list. Settings include start, count and sort order. If null, pagination is ignored and all records are retrieved.
programSubType programSubType Program type. If null, all programs are returned.

Return Value

type description
list<Program> Return list of programs that contain searchTerm. List is filtered and ordered based on page settings.

Faults

name description
ProgramWebServiceFault Thrown if any exception is encountered.

getProgramByExternalId

Retrieve a program by its external identifier.

Input Parameters

name type description
externalId string External identifier of program.

Return Value

type description
Program Return program mapped to specified external identifier.

Faults

name description
ProgramWebServiceFault Thrown if any exception is encountered.

getProgramByPk

Retrieve a program by its primary key.

Input Parameters

name type description
programPk integer Primary key of program.

Return Value

type description
Program Return program mapped to specified primary key.

Faults

name description
ProgramWebServiceFault Thrown if any exception is encountered.

updateProgram

Update an existing program. Related data collections associated with program are linked to updated program.

Update is terminated if EPG workflow is currently in progress.

Input Parameters

name type description
program Program Program to be updated.

Return Value

type description
Program Return updated program.

Faults

name description
ProgramWebServiceFault Thrown if any exception is encountered.