GET attendance/getScheduledAction?PageNumber={PageNumber}&PageSize={PageSize}&PersonId={PersonId}&TimeFrom={TimeFrom}&TimeTo={TimeTo}&Status={Status}&TimeLastChange={TimeLastChange}&Token={Token}
Retrieve scheduled action data of the person, which are currently stored in the system. Application privilege "View" for licensed agenda "Requests" required. Data may also be restricted by record permission "View" and "View attendance "of agenda "Persons"
Request Information
Authorization
- Authorization by token required
Availability
- Method can be used
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
PageNumber |
Page number |
integer |
Matching regular expression pattern: ([0-9]+) |
PageSize |
Number of the records on the page |
integer |
Matching regular expression pattern: ([0-9]+) |
PersonId |
Unique identification of the person in the system |
string |
Required String length: inclusive between 0 and 100 |
TimeFrom |
The begin of the time range in format "yyyy-mm-ddThh:mi:ss". The value is included |
date |
None. |
TimeTo |
The end of the time range in format "yyyy-mm-ddThh:mi:ss". The value is included |
date |
None. |
Status |
The status of the scheduled action. The meaning is : 0 - new; 1 - approved; 2 - waiting for cancel; 3 - reject; 4 - cancelled; 5 - deleted |
integer |
None. |
TimeLastChange |
The last change time of the data record. Can be used to check manual modification of data record |
date |
Data type: DateTime |
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
None.
Response Information
Response Codes
Http Code | Error Number | Description |
---|---|---|
200 request succesfully done | 0 | Successfully done |
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 server refuses fo fulfill the request | 2141 | Record permission View or View attendance of agenda Persons violated for [{0}] |
404 required resource does not exist on the server | 1100 | PersonId [{0}] not found |
404 required resource does not exist on the server | 1132 | No scheduled action 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 |
Resource Description
AttendanceGetScheduledActionRespName | Description | Type | Additional information |
---|---|---|---|
PersonId |
Unique identification of the person in the system |
string |
None. |
Actions | Collection of Action |
None. |
|
Paging | PagingResp |
None. |
Response Formats
application/json
{"PersonId":"100200300","Actions":[{"SalaryElementExtCode":"Holiday","DateFrom":"\/Date(1733645347994)\/","DateTo":"\/Date(1733818147994)\/","ApprovedBy":"900900900","ApprovalDate":"","Status":1,"ActionType":0,"ValueDays":0,"ValueTime":0,"IntervalBegin":0,"IntervalEnd":0,"DeterminedApprover":"900900900","TimeLastChange":"\/Date(1733645347994)\/"},{"SalaryElementExtCode":"Holiday","DateFrom":"\/Date(1733990947994)\/","DateTo":"\/Date(1734163747994)\/","ApprovedBy":"900900900","ApprovalDate":"","Status":1,"ActionType":0,"ValueDays":0,"ValueTime":0,"IntervalBegin":0,"IntervalEnd":0,"DeterminedApprover":"900900900","TimeLastChange":"\/Date(1733645347994)\/"},{"SalaryElementExtCode":"Holiday","DateFrom":"\/Date(1734336547994)\/","DateTo":"\/Date(1734509347994)\/","ApprovedBy":"900900900","ApprovalDate":"","Status":1,"ActionType":0,"ValueDays":0,"ValueTime":0,"IntervalBegin":0,"IntervalEnd":0,"DeterminedApprover":"","TimeLastChange":"\/Date(1733645347994)\/"}],"Paging":{"CurrentPage":1,"PageSize":25,"TotalCount":3,"TotalPages":1}}
application/xml
<Response> <PersonId>100200300</PersonId> <Actions> <Action> <SalaryElementExtCode>Holiday</SalaryElementExtCode> <ApprovedBy>900900900</ApprovedBy> <ApprovalDate /> <ActionType>0</ActionType> <ValueDays>0</ValueDays> <ValueTime>0</ValueTime> <IntervalBegin>0</IntervalBegin> <IntervalEnd>0</IntervalEnd> <DeterminedApprover>900900900</DeterminedApprover> <TimeLastChange>2024-12-08T08:09:07.9944128Z</TimeLastChange> </Action> <Action> <SalaryElementExtCode>Holiday</SalaryElementExtCode> <ApprovedBy>900900900</ApprovedBy> <ApprovalDate /> <ActionType>0</ActionType> <ValueDays>0</ValueDays> <ValueTime>0</ValueTime> <IntervalBegin>0</IntervalBegin> <IntervalEnd>0</IntervalEnd> <DeterminedApprover>900900900</DeterminedApprover> <TimeLastChange>2024-12-08T08:09:07.9944128Z</TimeLastChange> </Action> <Action> <SalaryElementExtCode>Holiday</SalaryElementExtCode> <ApprovedBy>900900900</ApprovedBy> <ApprovalDate /> <ActionType>0</ActionType> <ValueDays>0</ValueDays> <ValueTime>0</ValueTime> <IntervalBegin>0</IntervalBegin> <IntervalEnd>0</IntervalEnd> <DeterminedApprover /> <TimeLastChange>2024-12-08T08:09:07.9944128Z</TimeLastChange> </Action> </Actions> <Paging> <CurrentPage>1</CurrentPage> <PageSize>25</PageSize> <TotalCount>3</TotalCount> <TotalPages>1</TotalPages> </Paging> </Response>
text/json
{ "PersonId": "sample string 1", "Actions": [ { "SalaryElementExtCode": "sample string 1", "ApprovedBy": "sample string 4", "ApprovalDate": "sample string 5", "ActionType": 7, "ValueDays": 1.1, "ValueTime": 1, "IntervalBegin": 1, "IntervalEnd": 1, "DeterminedApprover": "sample string 8", "TimeLastChange": "2024-12-09T05:37:21.9835004+01:00" }, { "SalaryElementExtCode": "sample string 1", "ApprovedBy": "sample string 4", "ApprovalDate": "sample string 5", "ActionType": 7, "ValueDays": 1.1, "ValueTime": 1, "IntervalBegin": 1, "IntervalEnd": 1, "DeterminedApprover": "sample string 8", "TimeLastChange": "2024-12-09T05:37:21.9835004+01:00" } ], "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"> <PersonId>sample string 1</PersonId> <Actions> <Action> <SalaryElementExtCode>sample string 1</SalaryElementExtCode> <ApprovedBy>sample string 4</ApprovedBy> <ApprovalDate>sample string 5</ApprovalDate> <ActionType>7</ActionType> <ValueDays>1.1</ValueDays> <ValueTime>1</ValueTime> <IntervalBegin>1</IntervalBegin> <IntervalEnd>1</IntervalEnd> <DeterminedApprover>sample string 8</DeterminedApprover> <TimeLastChange>2024-12-09T05:37:21.9835004+01:00</TimeLastChange> </Action> <Action> <SalaryElementExtCode>sample string 1</SalaryElementExtCode> <ApprovedBy>sample string 4</ApprovedBy> <ApprovalDate>sample string 5</ApprovalDate> <ActionType>7</ActionType> <ValueDays>1.1</ValueDays> <ValueTime>1</ValueTime> <IntervalBegin>1</IntervalBegin> <IntervalEnd>1</IntervalEnd> <DeterminedApprover>sample string 8</DeterminedApprover> <TimeLastChange>2024-12-09T05:37:21.9835004+01:00</TimeLastChange> </Action> </Actions> <Paging> <CurrentPage>1</CurrentPage> <PageSize>2</PageSize> <TotalCount>3</TotalCount> <TotalPages>4</TotalPages> </Paging> </Response>