POST attendance/getAttendanceData?PageNumber={PageNumber}&PageSize={PageSize}&Token={Token}
Retrieve attendance data of the person. Application privilege "Show" for licensed agenda "Summary report" required. Functionality may also be restricted by record permission "View attendance" of agenda "Persons"and "View" of agenda "Salary elements".
Request Information
Authorization
- Authorization by token required
Availability
- Method can be used
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
PageNumber |
Optional parameter may be omitted. All records are displayed when is omitted otherwise specific page is displayed |
integer |
Matching regular expression pattern: ([0-9]+) |
PageSize |
Optional parameter may be omitted. Define number of records in the page. |
integer |
Matching regular expression pattern: ([0-9]+) |
Token |
The action is authorized by this token. Token should generated by calling action "POST login". Expiration time of each token is 20 seconds |
globally unique identifier |
Required |
Body Parameters
AttendanceGetAttendanceDataReqName | Description | Type | Additional information |
---|---|---|---|
DateFrom |
Begin(included) of the time period. This is mandatory parameter. |
date |
Required |
DateTo |
End(included) of the time period. This is mandatory parameter. |
date |
Required |
CloseDataFlag |
Value 1 means to get closed attendance data only. Value 0 means get all attendance data. This is optional parameter and default value is 0 |
integer |
Matching regular expression pattern: [0,1] |
PersonIds |
The list of the person id's |
Collection of PersonIdToGet |
None. |
SalaryElementExtCodes |
The list of the salary element external codes |
Collection of SalaryElementToGet |
None. |
Request Formats
application/json
{"DateFrom":"\/Date(1726110788432)\/","DateTo":"\/Date(1728702788432)\/","CloseDataFlag":0,"PersonIds":[{"PersonId":"0000162"},{"PersonId":"0000182"},{"PersonId":"0000049"}],"SalaryElementExtCodes":[{"SalaryElementExtCode":"SAT50","TypeOfSum":2,"TypeOfSalaryElement":5},{"SalaryElementExtCode":"HOL","TypeOfSum":3,"TypeOfSalaryElement":7}]}
application/xml
<Request> <DateFrom>2024-09-12T03:13:08.4321905Z</DateFrom> <DateTo>2024-10-12T03:13:08.4321905Z</DateTo> <CloseDataFlag>0</CloseDataFlag> <PersonIds> <PersonIdToGet> <PersonId>0000162</PersonId> </PersonIdToGet> <PersonIdToGet> <PersonId>0000182</PersonId> </PersonIdToGet> <PersonIdToGet> <PersonId>0000049</PersonId> </PersonIdToGet> </PersonIds> <SalaryElementExtCodes> <SalaryElementToGet> <SalaryElementExtCode>SAT50</SalaryElementExtCode> <TypeOfSum>2</TypeOfSum> <TypeOfSalaryElement>5</TypeOfSalaryElement> </SalaryElementToGet> <SalaryElementToGet> <SalaryElementExtCode>HOL</SalaryElementExtCode> <TypeOfSum>3</TypeOfSum> <TypeOfSalaryElement>7</TypeOfSalaryElement> </SalaryElementToGet> </SalaryElementExtCodes> </Request>
text/json
{ "DateFrom": "2024-09-12T15:16:18.9823227+02:00", "DateTo": "2024-09-12T15:16:18.9823227+02:00", "CloseDataFlag": 1, "PersonIds": [ { "PersonId": "sample string 1" }, { "PersonId": "sample string 1" } ], "SalaryElementExtCodes": [ { "SalaryElementExtCode": "sample string 1", "TypeOfSum": 1, "TypeOfSalaryElement": 1 }, { "SalaryElementExtCode": "sample string 1", "TypeOfSum": 1, "TypeOfSalaryElement": 1 } ] }
text/xml
<Request xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <DateFrom>2024-09-12T15:16:18.9823227+02:00</DateFrom> <DateTo>2024-09-12T15:16:18.9823227+02:00</DateTo> <CloseDataFlag>1</CloseDataFlag> <PersonIds> <PersonIdToGet> <PersonId>sample string 1</PersonId> </PersonIdToGet> <PersonIdToGet> <PersonId>sample string 1</PersonId> </PersonIdToGet> </PersonIds> <SalaryElementExtCodes> <SalaryElementToGet> <SalaryElementExtCode>sample string 1</SalaryElementExtCode> <TypeOfSum>1</TypeOfSum> <TypeOfSalaryElement>1</TypeOfSalaryElement> </SalaryElementToGet> <SalaryElementToGet> <SalaryElementExtCode>sample string 1</SalaryElementExtCode> <TypeOfSum>1</TypeOfSum> <TypeOfSalaryElement>1</TypeOfSalaryElement> </SalaryElementToGet> </SalaryElementExtCodes> </Request>
Response Information
Response Codes
Http Code | Error Number | Description |
---|---|---|
200 request succesfully done | 0 | Successfully done |
202 request succesfully done | 0 | Successfully done, but some data blocked by record permissions |
400 bad request | 1002 | Entry parameter missing or parameter bindigs failed |
401 unauthorized | 1000 | Token {0} not found |
401 unauthorized | 1001 | Token {0} already expired |
401 unauthorized | 1006 | Ip filter violated for ip client address [{0}] |
401 unauthorized | 1007 | Ip filter [{0}] parsing failed |
401 unauthorized | 1008 | Request rate policy violated for [{0}] |
403 bad request | 2302 | Privilege View of agenda Summary report violated for [all] |
403 bad request | 2303 | Input parameter DateFrom is higher than DateTo or maximal allowed timespan exceeded |
404 required resource does not exist on the server | 2305 | No attendance data found due privileges setting |
404 required resource does not exist on the server | 2304 | No attendance data found |
404 required resource does not exist on the server | 2301 | No salary element with defined external code found |
404 required resource does not exist on the server | 1100 | PersonId [{0}] not found |
404 required resource does not exist on the server | 1125 | No approver for personal Id[{0}] found |
404 required resource does not exist on the server | 1129 | Working time model or salary element external code not found |
404 required resource does not exist on the server | 1130 | Working days not found |
415 unsupported Media Type | The request entity has a media type which the server or resource does not support. Only application/json and application/xml are supported | |
500 internal error | Server exception description |
Resource Description
AttendanceGetAttendanceDataRespName | Description | Type | Additional information |
---|---|---|---|
AttendanceData | Collection of AttendanceData |
None. |
|
Paging | PagingResp |
None. |
Response Formats
application/json
{"Result":{"Message":"Processed with result: ExecOK","Code":0,"ModelStateErr":null},"Request":{"DateFrom":"\/Date(1726110788432)\/","DateTo":"\/Date(1728702788432)\/","CloseDataFlag":0,"PersonIds":[{"PersonId":"0000162"},{"PersonId":"0000182"},{"PersonId":"0000049"}],"SalaryElementExtCodes":[{"SalaryElementExtCode":"SAT50","TypeOfSum":2,"TypeOfSalaryElement":5},{"SalaryElementExtCode":"HOL","TypeOfSum":3,"TypeOfSalaryElement":7}]}}
application/xml
<Response> <Result> <Message>Processed with result: ExecOK</Message> <Code>0</Code> </Result> <Request> <DateFrom>2024-09-12T03:13:08.4321905Z</DateFrom> <DateTo>2024-10-12T03:13:08.4321905Z</DateTo> <CloseDataFlag>0</CloseDataFlag> <PersonIds> <PersonIdToGet> <PersonId>0000162</PersonId> </PersonIdToGet> <PersonIdToGet> <PersonId>0000182</PersonId> </PersonIdToGet> <PersonIdToGet> <PersonId>0000049</PersonId> </PersonIdToGet> </PersonIds> <SalaryElementExtCodes> <SalaryElementToGet> <SalaryElementExtCode>SAT50</SalaryElementExtCode> <TypeOfSum>2</TypeOfSum> <TypeOfSalaryElement>5</TypeOfSalaryElement> </SalaryElementToGet> <SalaryElementToGet> <SalaryElementExtCode>HOL</SalaryElementExtCode> <TypeOfSum>3</TypeOfSum> <TypeOfSalaryElement>7</TypeOfSalaryElement> </SalaryElementToGet> </SalaryElementExtCodes> </Request> </Response>
text/json
{ "AttendanceData": [ { "PersonId": "sample string 1", "SalaryElementExtCode": "sample string 2", "TypeOfSalaryElement": 3, "TypeOfSum": 4, "TimePeriod": "2024-09-12T15:16:19.001199+02:00", "Time": 1, "Days": 1.1, "Money": 1.0, "Occurence": 1, "TimeTransferred": 1, "DaysTransferred": 1.1, "MoneyTransferred": 1.0, "OccurenceTransferred": 1, "TimeTransfer": 1, "DaysTransfer": 1.1, "MoneyTransfer": 1.0, "OccurenceTransfer": 1 }, { "PersonId": "sample string 1", "SalaryElementExtCode": "sample string 2", "TypeOfSalaryElement": 3, "TypeOfSum": 4, "TimePeriod": "2024-09-12T15:16:19.001199+02:00", "Time": 1, "Days": 1.1, "Money": 1.0, "Occurence": 1, "TimeTransferred": 1, "DaysTransferred": 1.1, "MoneyTransferred": 1.0, "OccurenceTransferred": 1, "TimeTransfer": 1, "DaysTransfer": 1.1, "MoneyTransfer": 1.0, "OccurenceTransfer": 1 } ], "Paging": { "CurrentPage": 1, "PageSize": 2, "TotalCount": 3, "TotalPages": 4 } }
text/xml
<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <AttendanceData> <AttendanceData> <PersonId>sample string 1</PersonId> <SalaryElementExtCode>sample string 2</SalaryElementExtCode> <TypeOfSalaryElement>3</TypeOfSalaryElement> <TypeOfSum>4</TypeOfSum> <TimePeriod>2024-09-12T15:16:19.001199+02:00</TimePeriod> <Time>1</Time> <Days>1.1</Days> <Money>1</Money> <Occurence>1</Occurence> <TimeTransferred>1</TimeTransferred> <DaysTransferred>1.1</DaysTransferred> <MoneyTransferred>1</MoneyTransferred> <OccurenceTransferred>1</OccurenceTransferred> <TimeTransfer>1</TimeTransfer> <DaysTransfer>1.1</DaysTransfer> <MoneyTransfer>1</MoneyTransfer> <OccurenceTransfer>1</OccurenceTransfer> </AttendanceData> <AttendanceData> <PersonId>sample string 1</PersonId> <SalaryElementExtCode>sample string 2</SalaryElementExtCode> <TypeOfSalaryElement>3</TypeOfSalaryElement> <TypeOfSum>4</TypeOfSum> <TimePeriod>2024-09-12T15:16:19.001199+02:00</TimePeriod> <Time>1</Time> <Days>1.1</Days> <Money>1</Money> <Occurence>1</Occurence> <TimeTransferred>1</TimeTransferred> <DaysTransferred>1.1</DaysTransferred> <MoneyTransferred>1</MoneyTransferred> <OccurenceTransferred>1</OccurenceTransferred> <TimeTransfer>1</TimeTransfer> <DaysTransfer>1.1</DaysTransfer> <MoneyTransfer>1</MoneyTransfer> <OccurenceTransfer>1</OccurenceTransfer> </AttendanceData> </AttendanceData> <Paging> <CurrentPage>1</CurrentPage> <PageSize>2</PageSize> <TotalCount>3</TotalCount> <TotalPages>4</TotalPages> </Paging> </Response>