Schedule

Schedule service implementation.

Schedule

Bases: ONVIFService

0.0.1 2.6

Schedule service client.

Property	Details
First introduced	ONVIF 2.6 (June 2015)
Binding name	`ScheduleBinding` (`ver10/schedule/wsdl/schedule.wsdl`)
Operations	schedule.wsdl
Spec	Scheduler

GetServiceCapabilities

GetServiceCapabilities()

This operation returns the capabilities of the schedule service.

GetScheduleState

GetScheduleState(Token)

This operation requests the ScheduleState for the schedule instance specified by the given token.

GetScheduleInfo

GetScheduleInfo(Token)

This method returns a list of schedule info items, specified in the request.

Only found schedules shall be returned, i.e., the returned numbers of elements can differ from the requested element. The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching the specified tokens. If the number of requested items is greater than MaxLimit, a TooManyItems fault shall be returned.

GetScheduleInfoList

GetScheduleInfoList(Limit=None, StartReference=None)

This operation requests a list of all of ScheduleInfo items provided by the device.

A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. Please refer Access Control Service Specification for more details. The number of items returned shall not be greater the Limit parameter.

GetSchedules

GetSchedules(Token)

This operation returns the specified schedule item matching the given tokens.

The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching the specified tokens. If the number of requested items is greater than MaxLimit, a TooManyItems fault shall be returned

GetScheduleList

GetScheduleList(Limit=None, StartReference=None)

This operation requests a list of all of Schedule items provided by the device.

A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. Please refer Access Control Service Specification for more details. The number of items returned shall not be greater the Limit parameter.

CreateSchedule

CreateSchedule(Schedule)

This operation creates the specified schedule.

The token field of the schedule structure shall be empty, the device shall allocate a token for the schedule. The allocated token shall be returned in the response. If the client sends any value in the token field, the device shall return InvalidArgVal as generic fault code.

SetSchedule

SetSchedule(Schedule)

This operation modifies or creates the specified schedule.

ModifySchedule

ModifySchedule(Schedule)

This operation modifies or updates the specified schedule.

DeleteSchedule

DeleteSchedule(Token)

This operation will delete the specified schedule.

If it is associated with one or more entities some devices may not be able to delete the schedule, and consequently a ReferenceInUse fault shall be generated.

GetSpecialDayGroupInfo

GetSpecialDayGroupInfo(Token)

This operation requests a list of SpecialDayGroupInfo items matching the given tokens.

The device shall ignore tokens it cannot resolve and shall return an empty list if there are no items matching specified tokens. The device shall not return a fault in this case. If the number of requested items is greater than MaxLimit, a TooManyItems fault shall be returned.

GetSpecialDayGroupInfoList

GetSpecialDayGroupInfoList(Limit=None, StartReference=None)

This operation requests a list of all of SpecialDayGroupInfo items provided by the device.

A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. The number of items returned shall not be greater than Limit parameter.

GetSpecialDayGroups

GetSpecialDayGroups(Token)

This operation returns the specified special day group item matching the given token.

GetSpecialDayGroupList

GetSpecialDayGroupList(Limit=None, StartReference=None)

This operation requests a list of all of SpecialDayGroupList items provided by the device.

A call to this method shall return a StartReference when not all data is returned and more data is available. The reference shall be valid for retrieving the next set of data. Please refer Access Control Service Specification for more details. The number of items returned shall not be greater the Limit parameter.

CreateSpecialDayGroup

CreateSpecialDayGroup(SpecialDayGroup)

This operation creates the specified special day group.

The token field of the SpecialDayGroup structure shall be empty, the device shall allocate a token for the special day group. The allocated token shall be returned in the response. If there is any value in the token field, the device shall return InvalidArgVal as generic fault code.

SetSpecialDayGroup

SetSpecialDayGroup(SpecialDayGroup)

This operation modifies or creates the specified special day group.

ModifySpecialDayGroup

ModifySpecialDayGroup(SpecialDayGroup)

This operation updates the specified special day group.

DeleteSpecialDayGroup

DeleteSpecialDayGroup(Token)

This method deletes the specified special day group.

If it is associated with one or more schedules some devices may not be able to delete the special day group, and consequently a ReferenceInUse fault must be generated.