ScheduleService
Class of the Schedule Web Service.
Endpoint Metadata
- Namespace: http://videoscape.cisco.com/epg/webservices/schedule
- Endpoint Name: ScheduleWebService
- Endpoint Address: http(s)://{VMS URL}/LinearManager/webservices/schedule-service
The following methods are available on this endpoint:
Retrieve a paged list of schedules for a program with the given external identifier.
Input Parameters
name |
type |
description |
programExternalId |
string |
External identifier of program. |
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<Schedule>
|
Return list of schedules for program with specified external identifier. List is filtered and ordered based on page settings. |
Faults
name |
description |
ScheduleWebServiceFault |
Thrown if any exception is encountered. |
Retrieve a paged list of schedules for a program with the given primary key.
Input Parameters
name |
type |
description |
programPk |
integer |
Primary key of program. |
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<Schedule>
|
Return list of schedules for program with specified primary key. List is filtered and ordered based on page settings. |
Faults
name |
description |
ScheduleWebServiceFault |
Thrown if any exception is encountered. |
Retrieve a schedule by its primary key.
Input Parameters
name |
type |
description |
schedulePk |
integer |
Primary key of schedule. |
Return Value
type |
description |
Schedule
|
Return schedule mapped to specified primary key. |
Faults
name |
description |
ScheduleWebServiceFault |
Thrown if any exception is encountered. |
Update schedule. Custom fields related to schedule are linked to updated schedule.
Update is terminated if EPG workflow is in progress.
Input Parameters
name |
type |
description |
schedule |
Schedule
|
Schedule that will be updated. |
Return Value
type |
description |
Schedule
|
Return updated schedule. |
Faults
name |
description |
ScheduleWebServiceFault |
Thrown if any exception is encountered. |