Zum Hauptinhalt springen
Version: 5.5

Summary Service

Dieser Service enthält Methoden um auf die Zeitkonten der TimePunch Profile zugreifen zu können.

GetSummaryLocks

Diese Methode liefert alle Informationen zu den Monatsabschlüssen der Mitarbeiter zurück, die über das Suchobjekt gefunden werden.

List<SummaryLockDto> GetSummaryLocks(  
out TpFault fault,
TpAuthentication authentication,
UserSearchDto userFilter = null);
Needed Permissionmonthend@access
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
userFilterSearch object containing the user filter. The coverage will be applied to the filter.
Return valueList that contains all summary locks for the found staff members.

LoadAllYearlySummaries

Diese Methode lädt alle Jahresabschlüsse für den autorisierten Mitarbeiter und gibt diese zurück.

List<YearlySummaryDto> LoadAllYearlySummaries(  
out TpFault fault,
TpAuthentication authentication);
Needed Permissionsummary@access
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
Return valueList containing all yearly sumamries for the given user.

LoadDailySummaries

Mit dieser Methode kann eine Zusammenfassung der täglichen Arbeitszeit geladen werden.

List<DailySummaryDto> LoadDailySummaries(  
out TpFault fault,
TpAuthentication authentication,
DateTime startDate,
DateTime endDate);
Needed Permissionsummary@access
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
startDateFirst date to retrieve the daily summary
endDateLast date to retrieve the daily summary
Return valueList that contains all daily summaries from start through end date

LoadAllMonthlySummaries

Diese Methode kann dazu verwendet werden, um alle monatlichen Zusammenfassungen der Arbeitszeit für einen Benutzer zu laden.

List<MonthlySummaryDto> LoadAllMonthlySummaries(  
out TpFault fault,
TpAuthentication authentication);
Needed Permissionsummary@access
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication

LoadMonthlySummary

Diese Methode lädt die monatliche Zusammenfassung der Arbeitszeit für den Benutzer zu einem bestimmten Referenzdatum.

MonthlySummaryDto LoadMonthlySummary(  
out TpFault fault,
TpAuthentication authentication,
DateTime? referenceDate = null);
Needed Permissionsummary@access
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
referenceDateDate for that the monthly Summary shall be loaded, or null if the monthly summary for the current date shall be returned.
Return valueThe monthly summary for the given reference date.

LoadMonthlySummaries

Diese Methode lädt alle monatlichen Zusammenfassungen mit den übergebenen Ids.

List<MonthlySummaryDto> LoadMonthlySummaries(  
out TpFault fault,
TpAuthentication authentication,
List<Guid> summaryIds);
Needed Permissionsummary@access
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
summaryIdsIds of the monthly summaries to load.
Return valueThe monthly summary for the given reference date.

LoadTimeAccounts

Diese Methode lädt die aktuellen Zeitkonten der Mitarbeiter. Je nachdem, ob nur auf das Zeitkonto des autorisierten Mitarbeiters oder auf alle Mitarbeiterkonten zugegriffen werden soll, werden unterschiedliche Rechte benötigt.

List<TimeAccountDto> LoadTimeAccounts(  
out TpFault fault,
TpAuthentication authentication,
UserSearchDto userSearch,
DateTime? referenceDate = null);
Needed PermissiontimeAccounts@access / timeAccounts@report
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
userSearchInformation that are used to search the TimePunch profiles
referenceDateThe date of which the time accounts shall be loaded. By default this is always the day before today
Return valueList of Time account information entities

LoadYearlySummary

Diese Methode lädt die jährlichen Urlaubsdaten für den autorisierten Mitarbeiter anhand des Referenzdatums.

YearlySummaryDto LoadYearlySummary(  
out TpFault fault,
TpAuthentication authentication,
DateTime? referenceDate = null);
Needed Permissionsummary@access
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
referenceDateThe date of which the yearly summary shall be loaded, or null if the current date is used.
Return valueThe yearly summary for the given user and reference date.

LoadYearlySummaryByYear

Diese Methode lädt die jährlichen Urlaubsdaten für den autorisierten Mitarbeiter für ein definiertes Jahr.

YearlySummaryDto LoadYearlySummaryByYear(  
out TpFault fault,
TpAuthentication authentication,
int year);
Needed Permissionsummary@access
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
yearThe year of the yearly summary to load.
Return valueThe yearly summary for the given user and reference date.

ReCalculateAllSummaries

Diese Methode erzwingt das Neuberechnen aller Monatsdaten der im User Filter angegebenen Mitarbeiter ab dem Referenzdatum.

void ReCalculateAllSummaries(  
out TpFault fault,
TpAuthentication authentication,
UserSearchDto userFilter,
DateTime? referenceDate = null)
Needed Permissionsummary@manage
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
userFilterFilter that is used to search the TimePunch profiles.
referenceDateDefines the date since when the monthly summaries shall be re-calculated. If NULL, all monthly summaries of a user will be re-calculated.
Return valueThe calculated monthly summary, after the calculation date has been applied.

SaveMonthlySummary

Diese Methode speichert die Basisdaten zur Berechnung der monatlichen Arbeitsdaten.

MonthlySummaryDto SaveMonthlySummary(  
out TpFault fault,
TpAuthentication authentication,
MonthlySummarySaveDto summary);
Needed Permissionsummary@manage
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
summaryContains the data that can be used to calculate the monthly working time data.
Return valueThe calculated monthly summary, after the calculation date has been applied.

SaveYearlySummary

Diese Methode speichert die Basisdaten zur Berechnung des jährlichen Urlaubskontos.

YearlySummaryDto SaveYearlySummary(  
out TpFault fault,
TpAuthentication authentication,
YearlySummarySaveDto summary);
Needed Permissionsummary@manage
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
summaryContains the data that can be used to calculate the annual leave.
Return valueThe calculated annual leave, after the calculation date has been applied.

SearchMonthlySummaries

Diese Methode liefert anhand der übergebenen Suchparameter alle monatlichen Zusammenfassungen zurück.

List<MonthlySummaryDto> SearchMonthlySummaries(  
out TpFault fault,
TpAuthentication authentication,
MonthlySummarySearchDto searchDto);
Needed Permissionsummary@access
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
searchDtoSearch object to specify the summaries that will be returned.
Return valueThe found monthly summaries

SetSummaryLocks

Mit Hilfe dieser Methode kann der Monatsabschluss durchgeführt werden. Der Abschluss wird entweder für den gerade angemeldeten Mitarbeiter durchgeführt (falls die UserIDs NULL sind) oder für alle übergebenen IDs der Mitarbeiter.

void SetSummaryLocks(  
out TpFault fault,
TpAuthentication authentication,
DateTime? lockedUpTo,
List<Guid> userIds = null);
Needed PermissionCAN_MANAGE_MONTHEND, if lockedUpTo is filled CAN_RESET_MONTHEND, if lockedUpTo is NULL
NameModifierDescription
faultOutContains the error if an exception occurs.
authenticationUser authentication
lockedUpToDate up to that the month ends gets locked. If the lockedUpTo is NULL all months will be unlocked.
userIdsA list that contains the user ids for that the month end closing will be executed. If the list is NULL or empty, the current identity user will be used.