ChannelMapService
Session Bean implementation class ChannelMapWebService
Endpoint Metadata
- Namespace: http://videoscape.cisco.com/epg/webservices/channelmap
- Endpoint Name: ChannelMapWebService
- Endpoint Address: http(s)://{VMS URL}/LinearManager/webservices/channelmap-service
The following methods are available on this endpoint:
Activate a channel map with the given primary key.
Activation is terminated if an EPG workflow is currently in progress.
Input Parameters
name |
type |
description |
regionPk |
integer |
Primary key of the channel map to be activated. |
Faults
name |
description |
ChannelMapWebServiceFault |
Thrown if any exception is encountered. |
Create and persist a new channel map. Related channels are linked to new channel map.
Creation is terminated if an EPG workflow is currently in progress.
Following validation is performed on channel map data:
- Channel Map External ID must be unique.
Input Parameters
name |
type |
description |
region |
Region
|
The channel map to be created. |
Return Value
type |
description |
Region
|
Return persisted channel map in inactive state. |
Faults
name |
description |
ChannelMapWebServiceFault |
Thrown if any exception is encountered. |
Deactivate a channel map with the given primary key.
Deactivation is terminated if an EPG workflow is currently in progress.
Input Parameters
name |
type |
description |
regionPk |
integer |
Primary key of the channel map to be deactivated. |
Faults
name |
description |
ChannelMapWebServiceFault |
Thrown if any exception is encountered. |
Retrieve a paged list of channel maps containing searchTerm. List can be filtered by active state.
Input Parameters
name |
type |
description |
searchTerm |
string |
Text searched for in a channel map's name, location or external identifier. If null or empty, all channel maps 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. |
active |
boolean |
State of channel map. - null all channel maps
- true active channel maps only
- false inactive channel maps only
|
Return Value
type |
description |
list<Region>
|
Return list of channel maps containing searchTerm filtered by activity state. List is further filtered and ordered based on pagesettings. |
Faults
name |
description |
ChannelMapWebServiceFault |
Thrown if any exception is encountered. |
Retrieve a channel map by its primary key.
Input Parameters
name |
type |
description |
regionPk |
integer |
Primary key of channel map. |
Return Value
type |
description |
Region
|
region Return channel map with the given primary key. |
Faults
name |
description |
ChannelMapWebServiceFault |
Thrown if any exception is encountered. |
Update channel map. Related channels are linked to updated channel map.
Update is terminated if an EPG workflow is currently in progress.
Input Parameters
name |
type |
description |
region |
Region
|
The channel map to be updated. |
Return Value
type |
description |
Region
|
Return updated channel map. |
Faults
name |
description |
ChannelMapWebServiceFault |
Thrown if any exception is encountered. |