Click or drag to resize

IHourEntryGetWorkDayInfoByDateRangeAndUserGUID Method

Gets Work day information for an user from selected time frame.

Namespace: Severa.API
Assembly: Severa.SOAP.API (in Severa.SOAP.API.dll) Version: 1.0.0+cc2a5357b8231e24c5fd7606bb1e71a1374ad1e9
Syntax
List<WorkDayInfo> GetWorkDayInfoByDateRangeAndUserGUID(
	string businessUnitGUID,
	DateTime startdate,
	DateTime enddate,
	string userGUID,
	bool includeUnPaidAbsenses = false,
	bool includeInfoForInactiveUser = true
)

Parameters

businessUnitGUID  String
Business unit GUID, identifies case business unit.
startdate  DateTime
Start date, identifies the start date of the time frame, where data is searched from (Time information is ignored).
enddate  DateTime
End date, identifies the end date of the time frame, where data is searched from (Time information is ignored).
userGUID  String
User GUID, identifies the user, whose work day information is searched.
includeUnPaidAbsenses  Boolean  (Optional)
A flag to include unpaid absenses. Its false by default, so if its not provided then unpaid absenses are not included.
includeInfoForInactiveUser  Boolean  (Optional)

[Missing <param name="includeInfoForInactiveUser"/> documentation for "M:Severa.API.IHourEntry.GetWorkDayInfoByDateRangeAndUserGUID(System.String,System.DateTime,System.DateTime,System.String,System.Boolean,System.Boolean)"]

Return Value

ListWorkDayInfo
A collection of workday info objects or null when user was not provided.
Exceptions
ExceptionCondition
AuthenticationFailureExceptionThe caller could not be authenticated.
GeneralFailureExceptionAny other fault.
Remarks

Method returns user's daily work hours and activities, as well as other work day related information.

Data is useful for example when integrating to a system where user's salary is calculated.

Business unit GUID is used to find cases that belong to the given unit or any child unit in business unit hierarchy. Work hours entered to these cases are returned.

User can have work hour entries entered to cases that belong to different business units, so it is important to think what is given as parameter to this method.

See Also