Provides methods to manipulate business calendar settings. More...
Public Member Functions | |
void | AddTimeCategory (string sessionId, TimeCategory timeCategory) |
Please note that this function is deprecated. Please use AddTimeCategory2 instead. Adds the specified time category. More... | |
TimeCategory | AddTimeCategory2 (string sessionId, TimeCategory timeCategory) |
Adds the specified time category. More... | |
void | DeleteTimeCategory (string sessionId, TimeCategoryIdentity timeCategoryIdentity) |
Deletes the specified time category. More... | |
string | ExportBusinessCalendarDataAsXml (string sessionId) |
Exports the global business calendar in XML format. More... | |
string | GetBusinessCalendarDataAsXml (string sessionId, short calendarYear) |
Retrieves the global business calendar for a specified year in XML format. More... | |
string | GetBusinessCalendarDataAsXmlForResource (string sessionId, ResourceIdentity resourceIdentity, short calendarYear) |
Retrieves the business calendar for a specified year and a specified resource in XML format. More... | |
CalendarAuditLogEntryCollection | GetCalendarAuditLog (string sessionId, Agility.Sdk.Model.Resources.CalendarAuditLogFilter calendarAuditLogFilter) |
Retrieves the calendar audit log using the specified audit log filter. More... | |
DateTime | GetFutureDateUsingWorkingDays (string sessionId, DateTime fromDate, int days) |
Please note that this function is deprecated. Please use GetFutureDateUsingWorkingDays2 instead. Calculates a future date using a specified number of working days from a specified date. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled. More... | |
string | GetFutureDateUsingWorkingDays2 (string sessionId, int days) |
Calculates a future date using a specified number of working days from the current date. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled. More... | |
DateTime | GetFutureDateUsingWorkingHours (string sessionId, DateTime fromDate, int hours) |
Calculates the future date using a specified number of working hours from a specified date. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled. More... | |
DateTime | GetFutureDateUsingWorkingMinutes (string sessionId, DateTime fromDate, int minutes) |
Calculates a future date using a specified number of working minutes from a specified date. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled. More... | |
DateTime | GetFutureDateUsingWorkingSeconds (string sessionId, DateTime fromDate, int seconds) |
Calculates a future date using a specified number of working seconds from a specified date. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled. More... | |
DateTime | GetFutureDateUsingWorkingTime (string sessionId, DateTime fromDate, int days, int hours, int minutes, int seconds) |
Calculates a new data using the specified working days, hours, minutes and seconds from a specified From Date. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled. More... | |
TimePeriod | GetHoursBreakdown (string sessionId, int hours) |
Converts the specified hours into days and hours. The business calendar will NOT be used in the calculation. More... | |
TimePeriod | GetMinutesBreakdown (string sessionId, int minutes) |
Converts the specified hours into days, hours and minutes. The business calendar will NOT be used in the calculation. More... | |
DateTime | GetPastDateUsingWorkingDays (string sessionId, DateTime fromDate, int days) |
Calculates the past date based on the specified date and working days. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled. More... | |
DateTime | GetPastDateUsingWorkingHours (string sessionId, DateTime fromDate, int hours) |
Calculates the past date based on the specified date and working hours. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled. More... | |
DateTime | GetPastDateUsingWorkingMinutes (string sessionId, DateTime fromDate, int minutes) |
Calculates the past date based on the specified date and working minutes. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled. More... | |
DateTime | GetPastDateUsingWorkingSeconds (string sessionId, DateTime fromDate, int seconds) |
Calculates the past date based on the specified date and working seconds. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled. More... | |
DateTime | GetPastDateUsingWorkingTime (string sessionId, DateTime fromDate, int days, int hours, int minutes, int seconds) |
Calculates the past date based on the specified from date, days and working time. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled. More... | |
TimePeriod | GetSecondsBreakdown (string sessionId, int seconds) |
Converts the specified hours into days, hours, minutes and seconds. The business calendar will NOT be used in the calculation. More... | |
TimeCategory | GetTimeCategory (string sessionId, TimeCategoryIdentity timeCategoryIdentity) |
Retrieves the details of the specified time category. More... | |
bool | GetUseBusinessCalendar (string sessionId) |
Determines if the Use Business Calendar server setting is on or off. More... | |
int | GetWorkingDaysBetweenDates (string sessionId, DateTime fromDate, DateTime toDate) |
Calculates the working days between the two specified dates. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled. More... | |
int | GetWorkingHoursBetweenDates (string sessionId, DateTime fromDate, DateTime toDate) |
Calculates the working hours between the two specified dates. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled. More... | |
TimePeriod | GetWorkingHoursBreakdown (string sessionId, int hours) |
Retrieves the working time break down in number of days, hours, minutes and seconds. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled. More... | |
int | GetWorkingMinutesBetweenDates (string sessionId, DateTime fromDate, DateTime toDate) |
Calculates the working minutes between the two specified dates. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled. More... | |
TimePeriod | GetWorkingMinutesBreakdown (string sessionId, int minutes) |
Retrieves the working time break down in number of days, hours, minutes and seconds. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled. More... | |
int | GetWorkingSecondsBetweenDates (string sessionId, DateTime fromDate, DateTime toDate) |
Calculates the working seconds between the two specified dates. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled. More... | |
TimePeriod | GetWorkingSecondsBreakdown (string sessionId, int seconds) |
Retrieves the working time break down in number of days, hours, minutes and seconds. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled. More... | |
TimePeriod | GetWorkingTimeBetweenDates (string sessionId, DateTime fromDate, DateTime toDate) |
Retrieves the working time between the two specified dates. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled. More... | |
WorkPatternAuditLogEntryCollection | GetWorkPatternAuditLog (string sessionId, WorkPatternAuditLogFilter workPatternAuditLogFilter) |
Retrieves the work pattern audit log using the filter criteria. More... | |
WorkPatternIdentityCollection | GetWorkPatternsForResource (string sessionId, ResourceIdentity resourceIdentity) |
Retrieves the work patterns for the specified resource. More... | |
string | ImportBusinessCalendarDataFromXml (string sessionId, string xml) |
Imports a global business calendar described in the supplied XML. More... | |
bool | IsWorkingDateTime (string sessionId, DateTime dateToCheck) |
Determines if the specified date and time is within the defined working hours of the business calendar. More... | |
bool | IsWorkingDay (string sessionId, DateTime dateToCheck) |
Determines if the specified date is a working day as defined by the business calendar. The time part of the date is not checked. More... | |
string | UpdateBusinessCalendarDataFromXml (string sessionId, short calendarYear, string xml) |
Update the global business calendar for the specified year with the XML being passed in the xml parameter. More... | |
DateTime | UpdateBusinessCalendarDataFromXmlForResource (string sessionId, ResourceIdentity resourceIdentity, short calendarYear, bool overwrite, DateTime lastModifiedDate, string xml) |
Updates the specified resource's business calendar from the supplied XML. You can specify whether to overwrite the calendar or not, if it has been modified since you last retrieved it. More... | |
void | UpdateTimeCategory (string sessionId, TimeCategory timeCategory, bool overwrite) |
Updates the specified time category. More... | |
Provides methods to manipulate business calendar settings.
void AddTimeCategory | ( | string | sessionId, |
TimeCategory | timeCategory | ||
) |
Please note that this function is deprecated. Please use AddTimeCategory2 instead.
Adds the specified time category.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||
timeCategory | A TimeCategory object containing the time category information to add. Cannot be null
|
TimeCategory AddTimeCategory2 | ( | string | sessionId, |
TimeCategory | timeCategory | ||
) |
Adds the specified time category.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||
timeCategory | A TimeCategory object containing the time category information to add. Cannot be null
|
void DeleteTimeCategory | ( | string | sessionId, |
TimeCategoryIdentity | timeCategoryIdentity | ||
) |
Deletes the specified time category.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
timeCategoryIdentity | A TimeCategoryIdentity object identifying the time category to be deleted. Cannot be null
|
string ExportBusinessCalendarDataAsXml | ( | string | sessionId | ) |
Exports the global business calendar in XML format.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
string GetBusinessCalendarDataAsXml | ( | string | sessionId, |
short | calendarYear | ||
) |
Retrieves the global business calendar for a specified year in XML format.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
calendarYear | The desired year. For example, 2013. |
string GetBusinessCalendarDataAsXmlForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
short | calendarYear | ||
) |
Retrieves the business calendar for a specified year and a specified resource in XML format.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity identity object indicating the resource whose business calendar we want. Cannot be null
| ||||||||||||||||
calendarYear | The desired year. For example, 2013. |
CalendarAuditLogEntryCollection GetCalendarAuditLog | ( | string | sessionId, |
Agility.Sdk.Model.Resources.CalendarAuditLogFilter | calendarAuditLogFilter | ||
) |
Retrieves the calendar audit log using the specified audit log filter.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
calendarAuditLogFilter | A CalendarAuditLogFilter object containing the audit log filter criteria for retrieving audit log entries. Cannot be null
|
DateTime GetFutureDateUsingWorkingDays | ( | string | sessionId, |
DateTime | fromDate, | ||
int | days | ||
) |
Please note that this function is deprecated. Please use GetFutureDateUsingWorkingDays2 instead.
Calculates a future date using a specified number of working days from a specified date. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
fromDate | The date to which the working days are added. Cannot be null |
days | Number of working days to add to the from date. |
string GetFutureDateUsingWorkingDays2 | ( | string | sessionId, |
int | days | ||
) |
Calculates a future date using a specified number of working days from the current date. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
days | Number of working days to add to the current date. |
DateTime GetFutureDateUsingWorkingHours | ( | string | sessionId, |
DateTime | fromDate, | ||
int | hours | ||
) |
Calculates the future date using a specified number of working hours from a specified date. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
fromDate | The date to which the working hours are added. Cannot be null |
hours | Number of working hours to add to the from date. |
DateTime GetFutureDateUsingWorkingMinutes | ( | string | sessionId, |
DateTime | fromDate, | ||
int | minutes | ||
) |
Calculates a future date using a specified number of working minutes from a specified date. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
fromDate | The date to which the working minutes are added. Cannot be null |
minutes | Number of working minutes to add to the from date. |
DateTime GetFutureDateUsingWorkingSeconds | ( | string | sessionId, |
DateTime | fromDate, | ||
int | seconds | ||
) |
Calculates a future date using a specified number of working seconds from a specified date. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
fromDate | The date onto which the working seconds are added. Cannot be null |
seconds | Number of working seconds to add to the from date. |
DateTime GetFutureDateUsingWorkingTime | ( | string | sessionId, |
DateTime | fromDate, | ||
int | days, | ||
int | hours, | ||
int | minutes, | ||
int | seconds | ||
) |
Calculates a new data using the specified working days, hours, minutes and seconds from a specified From Date. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
fromDate | The start date from which future date should be calculated. Cannot be null |
days | The number of working days to add to the from/start date. |
hours | The number of working hours to add to the from/start date. |
minutes | The number of working minutes to add to the from/start date. |
seconds | The number of working seconds to add to the from/start date. |
TimePeriod GetHoursBreakdown | ( | string | sessionId, |
int | hours | ||
) |
Converts the specified hours into days and hours. The business calendar will NOT be used in the calculation.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
hours | Number of hours to break down. |
TimePeriod GetMinutesBreakdown | ( | string | sessionId, |
int | minutes | ||
) |
Converts the specified hours into days, hours and minutes. The business calendar will NOT be used in the calculation.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
minutes | Number of minutes to break down. |
DateTime GetPastDateUsingWorkingDays | ( | string | sessionId, |
DateTime | fromDate, | ||
int | days | ||
) |
Calculates the past date based on the specified date and working days. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
fromDate | Date from which the working days are subtracted. Cannot be null |
days | Number of working days to subtract from the specified date. |
DateTime GetPastDateUsingWorkingHours | ( | string | sessionId, |
DateTime | fromDate, | ||
int | hours | ||
) |
Calculates the past date based on the specified date and working hours. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
fromDate | Date from which the working hours are subtracted. Cannot be null |
hours | Number of working hours to subtract from the specified date. |
DateTime GetPastDateUsingWorkingMinutes | ( | string | sessionId, |
DateTime | fromDate, | ||
int | minutes | ||
) |
Calculates the past date based on the specified date and working minutes. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
fromDate | Date from which the working minutes are subtracted. Cannot be null |
minutes | Number of working minutes to subtract from the specified date. |
DateTime GetPastDateUsingWorkingSeconds | ( | string | sessionId, |
DateTime | fromDate, | ||
int | seconds | ||
) |
Calculates the past date based on the specified date and working seconds. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
fromDate | Date from which the working seconds are subtracted. Cannot be null |
seconds | Number of working seconds to subtract from the specified date. |
DateTime GetPastDateUsingWorkingTime | ( | string | sessionId, |
DateTime | fromDate, | ||
int | days, | ||
int | hours, | ||
int | minutes, | ||
int | seconds | ||
) |
Calculates the past date based on the specified from date, days and working time. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
fromDate | Date from which the working time is subtracted. Cannot be null |
days | The number of working days to subtract from the specified date. |
hours | The number of working hours to subtract from the specified date. |
minutes | The number of working minutes to subtract from the specified date. |
seconds | The number of working seconds to subtract from the specified date. |
TimePeriod GetSecondsBreakdown | ( | string | sessionId, |
int | seconds | ||
) |
Converts the specified hours into days, hours, minutes and seconds. The business calendar will NOT be used in the calculation.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
seconds | Number of seconds to break down |
TimeCategory GetTimeCategory | ( | string | sessionId, |
TimeCategoryIdentity | timeCategoryIdentity | ||
) |
Retrieves the details of the specified time category.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||
timeCategoryIdentity | A TimeCategoryIdentity object identifying the time category whose detils we need to obtain. Cannot be null
|
bool GetUseBusinessCalendar | ( | string | sessionId | ) |
Determines if the Use Business Calendar server setting is on or off.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
int GetWorkingDaysBetweenDates | ( | string | sessionId, |
DateTime | fromDate, | ||
DateTime | toDate | ||
) |
Calculates the working days between the two specified dates. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
fromDate | Start Date. Cannot be null |
toDate | End date. Cannot be null |
int GetWorkingHoursBetweenDates | ( | string | sessionId, |
DateTime | fromDate, | ||
DateTime | toDate | ||
) |
Calculates the working hours between the two specified dates. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
fromDate | Start date. Cannot be null |
toDate | End date. Cannot be null |
TimePeriod GetWorkingHoursBreakdown | ( | string | sessionId, |
int | hours | ||
) |
Retrieves the working time break down in number of days, hours, minutes and seconds. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
hours | Number of working hours to break down into days, hours, minutes and seconds. |
int GetWorkingMinutesBetweenDates | ( | string | sessionId, |
DateTime | fromDate, | ||
DateTime | toDate | ||
) |
Calculates the working minutes between the two specified dates. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
fromDate | From date. Cannot be null |
toDate | End date. Cannot be null |
TimePeriod GetWorkingMinutesBreakdown | ( | string | sessionId, |
int | minutes | ||
) |
Retrieves the working time break down in number of days, hours, minutes and seconds. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
minutes | Number of working minutes to break down into days, hours, minutes and seconds. |
int GetWorkingSecondsBetweenDates | ( | string | sessionId, |
DateTime | fromDate, | ||
DateTime | toDate | ||
) |
Calculates the working seconds between the two specified dates. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
fromDate | Start date. Cannot be null |
toDate | End date. Cannot be null |
TimePeriod GetWorkingSecondsBreakdown | ( | string | sessionId, |
int | seconds | ||
) |
Retrieves the working time break down in number of days, hours, minutes and seconds. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
seconds | Number of working seconds to break down into days, hours, minutes and seconds. |
TimePeriod GetWorkingTimeBetweenDates | ( | string | sessionId, |
DateTime | fromDate, | ||
DateTime | toDate | ||
) |
Retrieves the working time between the two specified dates. The business calendar will be used in the calculation, if the Use Business Calendar system setting is enabled.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
fromDate | Start date. Cannot be null |
toDate | End date. Cannot be null |
WorkPatternAuditLogEntryCollection GetWorkPatternAuditLog | ( | string | sessionId, |
WorkPatternAuditLogFilter | workPatternAuditLogFilter | ||
) |
Retrieves the work pattern audit log using the filter criteria.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
workPatternAuditLogFilter | A WorkPatternAuditLogFilter object containing the work pattern details for which the audit entries need to be retrieved. If work pattern information is not passed then it retrieves the audit log for all the work patterns in the system. Cannot be null
|
WorkPatternIdentityCollection GetWorkPatternsForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity | ||
) |
Retrieves the work patterns for the specified resource.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity identity object indicating the resource whose work patterns we want to retrieve. Cannot be null
|
string ImportBusinessCalendarDataFromXml | ( | string | sessionId, |
string | xml | ||
) |
Imports a global business calendar described in the supplied XML.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
xml | XML that represents the business calendar we are importing. Cannot be null or empty |
bool IsWorkingDateTime | ( | string | sessionId, |
DateTime | dateToCheck | ||
) |
Determines if the specified date and time is within the defined working hours of the business calendar.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
dateToCheck | Date to check whether it occurs during working time. Cannot be null |
bool IsWorkingDay | ( | string | sessionId, |
DateTime | dateToCheck | ||
) |
Determines if the specified date is a working day as defined by the business calendar. The time part of the date is not checked.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
dateToCheck | Date to check whether it occurs on a working day. |
string UpdateBusinessCalendarDataFromXml | ( | string | sessionId, |
short | calendarYear, | ||
string | xml | ||
) |
Update the global business calendar for the specified year with the XML being passed in the xml parameter.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. |
calendarYear | The calendar year. |
xml | XML that represents the new business calendar. Cannot be null or empty |
DateTime UpdateBusinessCalendarDataFromXmlForResource | ( | string | sessionId, |
ResourceIdentity | resourceIdentity, | ||
short | calendarYear, | ||
bool | overwrite, | ||
DateTime | lastModifiedDate, | ||
string | xml | ||
) |
Updates the specified resource's business calendar from the supplied XML. You can specify whether to overwrite the calendar or not, if it has been modified since you last retrieved it.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||
resourceIdentity | A ResourceIdentity identity object indicating the resource whose business calendar we want to update. Cannot be null
| ||||||||||||||||
calendarYear | The calendar year to update. | ||||||||||||||||
overwrite | If overwrite is true, then we update even if it has been modified by someone else since we last retrieved the calendar. If false, do not update if it has been modified by someone else since we last retrieved the calendar. | ||||||||||||||||
lastModifiedDate | Last modified date of calendar. The date/time of when you last read/loaded the calendar. Cannot be null | ||||||||||||||||
xml | XML that details the new business calendar. Cannot be null or empty |
void UpdateTimeCategory | ( | string | sessionId, |
TimeCategory | timeCategory, | ||
bool | overwrite | ||
) |
Updates the specified time category.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||
timeCategory | A TimeCategory object containing the time category information to update. Cannot be null
| ||||||||||||||||||||||||||||
overwrite | If set to true, updates even if someone else has updated since we retrieved the details of the time category. If set to false, then only update if noone else has modified since we got details of the time category. |