Skip to main content
Version: 8.1

system.user.editHoliday

This function is used in Python Scripting.

Description

Allows a holiday to be edited.

Client Permission Restrictions

Permission Type: User Management

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.editHoliday(holidayName, holiday)

Parameters

TypeParameterDescription
StringholidayNameThe name of the holiday to edit. Name is case-sensitive.
HolidayModelholidayThe edited holiday, as a HolidayModel object.

Returns

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

Scope

Gateway, Vision Client, Perspective Session

Code Examples

Example #1
# This example gets a holiday and edits it.

# 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.
holidayName = "Labor Day"
myHoliday = system.user.getHoliday(holidayName)
if myHoliday != None:
myHoliday.setRepeatAnnually(False)
response = system.user.editHoliday(holidayName, myHoliday)

warnings = response.getWarns()
print "Warnings are:"
printResponse(warnings)

errors = response.getErrors()
print "Errors are:"
printResponse(errors)

infos = response.getInfos()
print "Infos are:"
printResponse(infos)

"""The example above outputs the following:
Warnings are:
None
Errors are:
None
Infos are:
Holiday "Labor Day" updated.
"""