GET attendance/getSalaryElementsAll?PageNumber={PageNumber}&PageSize={PageSize}&Token={Token}
Retrieve all salary elements with defined external code in the system. Application privilege "View" for licensed agenda "Salary Elements" required. Data may also be restricted by record permission "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
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 | 2300 | Privilege View of agenda Salary elements violated for [all] |
404 required resource does not exist on the server | 2301 | No salary element wit defined external code 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
AttendanceGetSalaryElementsAllRespName | Description | Type | Additional information |
---|---|---|---|
SalaryElements | Collection of SalaryElement |
None. |
|
Paging | PagingResp |
None. |
Response Formats
application/json
Sample:
{"SalaryElements":[{"Title":"Holiday","SalaryElementExtCode":"HOL","SalaryElementCode1":"H","SalaryElementCode2":"H","TypeOfSalaryElement":1,"TypeOfSum":0},{"Title":"Working hours","SalaryElementExtCode":"WHS","SalaryElementCode1":"WH","SalaryElementCode2":"WH","TypeOfSalaryElement":2,"TypeOfSum":0},{"Title":"Bonus SUN","SalaryElementExtCode":"BSUN","SalaryElementCode1":"BS","SalaryElementCode2":"BS","TypeOfSalaryElement":3,"TypeOfSum":0}],"Paging":{"CurrentPage":1,"PageSize":25,"TotalCount":3,"TotalPages":1}}
application/xml
Sample:
<Response> <SalaryElements> <SalaryElement> <Title>Holiday</Title> <SalaryElementExtCode>HOL</SalaryElementExtCode> <SalaryElementCode1>H</SalaryElementCode1> <SalaryElementCode2>H</SalaryElementCode2> <TypeOfSalaryElement>1</TypeOfSalaryElement> <TypeOfSum>0</TypeOfSum> </SalaryElement> <SalaryElement> <Title>Working hours</Title> <SalaryElementExtCode>WHS</SalaryElementExtCode> <SalaryElementCode1>WH</SalaryElementCode1> <SalaryElementCode2>WH</SalaryElementCode2> <TypeOfSalaryElement>2</TypeOfSalaryElement> <TypeOfSum>0</TypeOfSum> </SalaryElement> <SalaryElement> <Title>Bonus SUN</Title> <SalaryElementExtCode>BSUN</SalaryElementExtCode> <SalaryElementCode1>BS</SalaryElementCode1> <SalaryElementCode2>BS</SalaryElementCode2> <TypeOfSalaryElement>3</TypeOfSalaryElement> <TypeOfSum>0</TypeOfSum> </SalaryElement> </SalaryElements> <Paging> <CurrentPage>1</CurrentPage> <PageSize>25</PageSize> <TotalCount>3</TotalCount> <TotalPages>1</TotalPages> </Paging> </Response>
text/json
Sample:
{ "SalaryElements": [ {}, {} ], "Paging": { "CurrentPage": 1, "PageSize": 2, "TotalCount": 3, "TotalPages": 4 } }
text/xml
Sample:
<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SalaryElements> <SalaryElement /> <SalaryElement /> </SalaryElements> <Paging> <CurrentPage>1</CurrentPage> <PageSize>2</PageSize> <TotalCount>3</TotalCount> <TotalPages>4</TotalPages> </Paging> </Response>