GET api/YearlySummaries?users={users}&logon={logon}&logoff={logoff}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| users | string |
None. |
|
| logon | string |
None. |
|
| logoff | string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of ReportYearlySummaryDto| Name | Description | Type | Additional information |
|---|---|---|---|
| User | ReportUserDto |
None. |
|
| RemainingLeaveUntilExpiration | decimal number |
None. |
|
| YearlySummaryStaticsId | globally unique identifier |
None. |
|
| SickNotPaidAsDaysInYear | decimal number |
None. |
|
| SickCompleteAsDaysInYear | decimal number |
None. |
|
| RemainingLeaveNewPeriod | decimal number |
None. |
|
| LeaveInYear | decimal number |
None. |
|
| LeaveInYearUntilExpiration | decimal number |
None. |
|
| LeaveInYearNewPeriod | decimal number |
None. |
|
| AdditionalLeave | decimal number |
None. |
|
| Year | integer |
None. |
|
| LeaveCarryForward | LeaveCarryForward |
None. |
|
| LeaveExpiration | LeaveExpiration |
None. |
|
| StartOfYearlySummary | date |
None. |
|
| EndOfYearlySummary | date |
None. |
|
| LeaveExpirationDate | date |
None. |
|
| AdditionalLeaveAsDays | decimal number |
None. |
|
| LeavePerDay | decimal number |
None. |
|
| LeaveCalculation | LeaveCalculation |
None. |
|
| AnnualLeave | decimal number |
None. |
|
| AnnualLeaveAsDays | decimal number |
None. |
|
| LeaveAsDaysInYear | decimal number |
None. |
|
| LeaveAsDaysInYearUntilExpiration | decimal number |
None. |
|
| LeaveAsDaysInYearNewPeriod | decimal number |
None. |
|
| SickAsDaysInYear | decimal number |
None. |
|
| RemainingLeaveAsDaysUntilExpiration | decimal number |
None. |
|
| RemainingLeaveAsDaysNewPeriod | decimal number |
None. |
|
| CreatedBy | globally unique identifier |
None. |
|
| Created | date |
None. |
|
| LastUpdateBy | globally unique identifier |
None. |
|
| LastUpdate | date |
None. |
|
| CreatedByUser | string |
None. |
|
| LastUpdateByUser | string |
None. |
|
| Id | globally unique identifier |
None. |
|
| IsNew | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[
null,
{
"$id": "1",
"User": null,
"RemainingLeaveUntilExpiration": 1.1,
"YearlySummaryStaticsId": "c76e5e7a-b1d4-46ca-b1d5-c249ce71fed2",
"SickNotPaidAsDaysInYear": 2.1,
"SickCompleteAsDaysInYear": 3.1,
"RemainingLeaveNewPeriod": 1.1,
"LeaveInYear": 4.1,
"LeaveInYearUntilExpiration": 5.1,
"LeaveInYearNewPeriod": 6.1,
"AdditionalLeave": 1.1,
"Year": 7,
"LeaveCarryForward": 0,
"LeaveExpiration": 0,
"StartOfYearlySummary": "2025-04-27T23:45:51.5378617+02:00",
"EndOfYearlySummary": "2025-04-27T23:45:51.5378617+02:00",
"LeaveExpirationDate": "2025-04-27T23:45:51.5378617+02:00",
"AdditionalLeaveAsDays": 11.1,
"LeavePerDay": 12.1,
"LeaveCalculation": 0,
"AnnualLeave": 1.1,
"AnnualLeaveAsDays": 13.1,
"LeaveAsDaysInYear": 14.1,
"LeaveAsDaysInYearUntilExpiration": 15.1,
"LeaveAsDaysInYearNewPeriod": 16.1,
"SickAsDaysInYear": 17.1,
"RemainingLeaveAsDaysUntilExpiration": 18.1,
"RemainingLeaveAsDaysNewPeriod": 19.1,
"CreatedBy": "dcc347a2-3e37-4176-84ad-aec2b0e1262d",
"Created": "2025-04-27T23:45:51.5378617+02:00",
"LastUpdateBy": "93ae6ed9-2648-481c-98d5-d8b32fe5c5ca",
"LastUpdate": "2025-04-27T23:45:51.5378617+02:00",
"CreatedByUser": "sample string 24",
"LastUpdateByUser": "sample string 25",
"Id": "2ad2bfae-d081-4e6b-9c22-bc8a41bee5c3",
"IsNew": true
}
]
text/html
Sample:
[null,{"$id":"1","User":null,"RemainingLeaveUntilExpiration":1.1,"YearlySummaryStaticsId":"c76e5e7a-b1d4-46ca-b1d5-c249ce71fed2","SickNotPaidAsDaysInYear":2.1,"SickCompleteAsDaysInYear":3.1,"RemainingLeaveNewPeriod":1.1,"LeaveInYear":4.1,"LeaveInYearUntilExpiration":5.1,"LeaveInYearNewPeriod":6.1,"AdditionalLeave":1.1,"Year":7,"LeaveCarryForward":0,"LeaveExpiration":0,"StartOfYearlySummary":"2025-04-27T23:45:51.5378617+02:00","EndOfYearlySummary":"2025-04-27T23:45:51.5378617+02:00","LeaveExpirationDate":"2025-04-27T23:45:51.5378617+02:00","AdditionalLeaveAsDays":11.1,"LeavePerDay":12.1,"LeaveCalculation":0,"AnnualLeave":1.1,"AnnualLeaveAsDays":13.1,"LeaveAsDaysInYear":14.1,"LeaveAsDaysInYearUntilExpiration":15.1,"LeaveAsDaysInYearNewPeriod":16.1,"SickAsDaysInYear":17.1,"RemainingLeaveAsDaysUntilExpiration":18.1,"RemainingLeaveAsDaysNewPeriod":19.1,"CreatedBy":"dcc347a2-3e37-4176-84ad-aec2b0e1262d","Created":"2025-04-27T23:45:51.5378617+02:00","LastUpdateBy":"93ae6ed9-2648-481c-98d5-d8b32fe5c5ca","LastUpdate":"2025-04-27T23:45:51.5378617+02:00","CreatedByUser":"sample string 24","LastUpdateByUser":"sample string 25","Id":"2ad2bfae-d081-4e6b-9c22-bc8a41bee5c3","IsNew":true}]
application/xml, text/xml
Sample:
<ArrayOfReportYearlySummaryDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TimePunch.Core.Services.ReportingService.Dto">
<ReportYearlySummaryDto i:nil="true" />
<ReportYearlySummaryDto z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
<Id>2ad2bfae-d081-4e6b-9c22-bc8a41bee5c3</Id>
<IsNew>true</IsNew>
<Created>2025-04-27T23:45:51.5378617+02:00</Created>
<CreatedBy>dcc347a2-3e37-4176-84ad-aec2b0e1262d</CreatedBy>
<CreatedByUser>sample string 24</CreatedByUser>
<LastUpdate>2025-04-27T23:45:51.5378617+02:00</LastUpdate>
<LastUpdateBy>93ae6ed9-2648-481c-98d5-d8b32fe5c5ca</LastUpdateBy>
<LastUpdateByUser>sample string 25</LastUpdateByUser>
<AdditionalLeave>1.1</AdditionalLeave>
<AdditionalLeaveAsDays>11.1</AdditionalLeaveAsDays>
<AnnualLeave>1.1</AnnualLeave>
<AnnualLeaveAsDays>13.1</AnnualLeaveAsDays>
<EndOfYearlySummary>2025-04-27T23:45:51.5378617+02:00</EndOfYearlySummary>
<LeaveAsDaysInYear>14.1</LeaveAsDaysInYear>
<LeaveAsDaysInYearNewPeriod>16.1</LeaveAsDaysInYearNewPeriod>
<LeaveAsDaysInYearUntilExpiration>15.1</LeaveAsDaysInYearUntilExpiration>
<LeaveCalculation>Days</LeaveCalculation>
<LeaveCarryForward>Never</LeaveCarryForward>
<LeaveExpiration>Instantly</LeaveExpiration>
<LeaveExpirationDate>2025-04-27T23:45:51.5378617+02:00</LeaveExpirationDate>
<LeaveInYear>4.1</LeaveInYear>
<LeaveInYearNewPeriod>6.1</LeaveInYearNewPeriod>
<LeaveInYearUntilExpiration>5.1</LeaveInYearUntilExpiration>
<LeavePerDay>12.1</LeavePerDay>
<RemainingLeaveAsDaysNewPeriod>19.1</RemainingLeaveAsDaysNewPeriod>
<RemainingLeaveAsDaysUntilExpiration>18.1</RemainingLeaveAsDaysUntilExpiration>
<RemainingLeaveNewPeriod>1.1</RemainingLeaveNewPeriod>
<RemainingLeaveUntilExpiration>1.1</RemainingLeaveUntilExpiration>
<SickAsDaysInYear>17.1</SickAsDaysInYear>
<SickCompleteAsDaysInYear>3.1</SickCompleteAsDaysInYear>
<SickNotPaidAsDaysInYear>2.1</SickNotPaidAsDaysInYear>
<StartOfYearlySummary>2025-04-27T23:45:51.5378617+02:00</StartOfYearlySummary>
<User i:nil="true" />
<Year>7</Year>
<YearlySummaryStaticsId>c76e5e7a-b1d4-46ca-b1d5-c249ce71fed2</YearlySummaryStaticsId>
</ReportYearlySummaryDto>
</ArrayOfReportYearlySummaryDto>