CorrectionService
Class of the Schedule Correction Web Service.
Endpoint Metadata
- Namespace: http://videoscape.cisco.com/epg/webservices/correction
- Endpoint Name: CorrectionWebService
- Endpoint Address: http(s)://{VMS URL}/LinearManager/webservices/correction-service
The following methods are available on this endpoint:
Create and persist a new schedule correction.
Following validation is performed on schedule correction data:
- Start date must precede end date in time.
- Elapsed time between start and end dates must be less than 24 hours.
Creation is terminated if EPG workflow is currently in progress.
Input Parameters
name |
type |
description |
scheduleCorrection |
ScheduleCorrection
|
Schedule correction to be created. |
Return Value
Faults
name |
description |
CorrectionWebServiceFault |
Thrown if any exception is encountered. |
Mark specified schedule correction as deleted. Schedule correction will not be removed, a deleted flag is set to true instead.
Delete is terminated if EPG workflow is currently in progress.
Input Parameters
name |
type |
description |
scheduleCorrectionPk |
integer |
Primary key of schedule correction to mark as deleted. |
Faults
name |
description |
CorrectionWebServiceFault |
Thrown if any exception is encountered. |
Retrieve a list of all schedule corrections that occur on a particular date and station.
Input Parameters
name |
type |
description |
stationPk |
integer |
Primary key of station on which schedule corrections occur. Must not be null. |
startDate |
date |
Date on which schedule corrections occur. Must not be null. |
Return Value
type |
description |
list<ScheduleCorrection>
|
Return a list of schedule corrections that occur on startDate and attributed to stationPk. |
Faults
name |
description |
CorrectionWebServiceFault |
Thrown if any exception is encountered |
Retrieve a schedule correction by its primary key.
Input Parameters
name |
type |
description |
correctionPk |
integer |
Primary key of schedule correction. |
Return Value
type |
description |
ScheduleCorrection
|
Return schedule correction mapped to specified primary key. |
Faults
name |
description |
CorrectionWebServiceFault |
Thrown if any exception is encountered. |
Update an existing schedule correction by creating new correction and marking old correction as deleted.
Following validation is performed on schedule correction data:
- Start date must precede end date in time.
- Elapsed time between start and end dates must be less than 24 hours.
Update is terminated if EPG workflow is currently in progress.
Input Parameters
name |
type |
description |
scheduleCorrection |
ScheduleCorrection
|
The schedule correction to be updated. |
Return Value
Faults
name |
description |
CorrectionWebServiceFault |
Thrown if any exception is encountered. |