system.user.editSchedule

This function is used in Python Scripting.

Description

Allows a schedule to be edited.

Client Permission Restrictions

Client access to this scripting function is blocked to users that do not meet the role/zone requirements for the above permission type. This function is unaffected when run in the Gateway scope.

Syntax

system.user.editSchedule(scheduleName, schedule)

Parameters

String scheduleName - The name of the schedule to edit. Name is case-sensitive.

AbstractScheduleModel schedule - The edited schedule.

Returns

UIResponse - an object with lists of warnings, errors, and info about the success or failure of the edit.

Scope

All

Code Examples

Code Snippet

# This example tries to edit the schedule MySchedule, and prints the results of the action.
 
# This function prints the response received
def printResponse(responseList):
    if len(responseList) > 0:
        for response in responseList:
            print "", response
    else:
        print " None"
 
# The main function
oldScheduleName = "MySchedule"
mySchedule = system.user.getSchedule(oldScheduleName)
if mySchedule != None and mySchedule.getType() == "basic schedule":
	mySchedule.setObserveHolidays(False)
	mySchedule.setName("MyEditedSchedule")
	mySchedule.setDescription("A modified description")
	response = system.user.editSchedule(oldScheduleName, mySchedule)
	warnings = response.getWarns()
	print "Warnings are:"
	printResponse(warnings)
	 
	errors = response.getErrors()
	print "Errors are:"
	printResponse(errors)
	 
	infos = response.getInfos()
	print "Infos are:"
	printResponse(infos)
else:
	print "Basic schedule", oldScheduleName, "not found."

Output

Warnings are:
 None
Errors are:
 None
Infos are:
 Schedule "MyEditedSchedule" updated.

Contents

Strategic Partner Links

Resources

All Manual Versions