Skip to main content
Version: 7.9

system.user.removeHoliday

This function is used in Python Scripting.

Description​

Allows a holiday to be deleted.

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.removeHoliday(holidayName)

Parameters​

TypeParameterDescription
StringholidayNameThe name of the holiday to delete. Name is case-sensitive.

Returns​

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

Scope​

Gateway, Designer, Client

Code Examples​

Example #1
def printResponse(responseList):
    if len(responseList) > 0:
        for response in responseList:
            print "", response
    else:
        print " None"
 
holidayName = "Labor Day"
response = system.user.removeHoliday(holidayName)
 
warnings = response.getWarns()
print "Warnings are:"
printResponse(warnings)
 
errors = response.getErrors()
print "Errors are:"
printResponse(errors)
 
infos = response.getInfos()
print "Infos are:"
printResponse(infos)
Example #1 Output
Warnings are:
 None
Errors are:
 None
Infos are:
 Holiday "Labor Day" deleted.