StationService

Endpoint Metadata

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

The following methods are available on this endpoint:

createStation

Create and persist a new station. Station is linked to related data collections: genres, images and custom fields.

Creation is terminated if EPG workflow is currently in progress.

Input Parameters

name type description
station Station Station to be created.

Return Value

type description
Station Return persisted station in active state.

Faults

name description
StationWebServiceFault Thrown if any exception is encountered.

deactivateStation

Deactivate a station with the given primary key. Mark related channel maps as deleted.

Deactivation is terminated if EPG workflow is in progress.

Input Parameters

name type description
stationPk integer Primary key of station.

Faults

name description
StationWebServiceFault Thrown if any exception is encountered.

findStations

Retrieve a paged list of stations that contain searchTerm. List can be filtered by active state.

Input Parameters

name type description
searchTerm string Text to search for in station's name, call sign or external identifier. If null or empty, all stations are returned.
active boolean State of station.
  • null all stations
  • true active stations only
  • false inactive stations only
pageInfoAdapter PageInfoAdapter Page settings for result list. Settings include start, count and sort order. If null, pagination is ignored and all records are retrieved.

Return Value

type description
list<Station> Return list of stations containing searchTerm and filtered by activity state. List is further filtered and ordered based on pagesettings.

Faults

name description
StationWebServiceFault Thrown if any exception is encountered.

getStationByExternalId

Retrieve a station by its external identifier.

Input Parameters

name type description
externalId string External identifier of station.

Return Value

type description
Station Return station mapped to specified external identifier.

Faults

name description
StationWebServiceFault Thrown if any exception is encountered.

getStationByPk

Retrieve a station by its primary key.

Input Parameters

name type description
stationPk integer Primary key of station.

Return Value

type description
Station Return station mapped to specified primary key.

Faults

name description
StationWebServiceFault Thrown if any exception is encountered.

updateStation

Update an existing station. Related data collections are linked to updated station.

Update is terminated if EPG workflow is in progress.

Input Parameters

name type description
station Station Station to be updated.

Return Value

type description
Station Return updated station.

Faults

name description
StationWebServiceFault Thrown if any exception is encountered.