system.user.editHoliday

This feature is new in Ignition version 7.8.0

Description

Allows a holiday to be edited.

Syntax

Parameters

String holidayName - The name of the holiday to edit. Name is case-sensitive.

HolidayModel holiday - The edited holiday .

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 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)

Output

Warnings are:
 None
Errors are:
 None
Infos are:
 Holiday "Labor Day" updated.