API

Human resource APIs

GET system/reports/113538/result-set?fromDate={fromDate}&toDate={toDate}&traversalReportJobId={traversalReportJobId}

Human Resource report providing absence overview in hours and percentage per employee Report will, by default, show numbers from current year - this can be overridden by specifying a from/to-date. Only one WorkAgreementId can be filtered against when running the report. Department column will show current department for employee, but filter will be set against Department from the Work Log (WHL)

Report name Absence overview
Report identifier 113538
HTTP method GET
URI https://api.rambase.net/system/reports/113538/result-set?fromDate={fromDate}&toDate={toDate}&traversalReportJobId={traversalReportJobId}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 6005, version 9

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

fromDate Date, optional From date used to filter data
toDate Date, optional To date used to filter data
traversalReportJobId Integer, optional Report job identifier used when the full report result set is to be traversed. Reports that are optimized for traversing the full result set will use this.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

DepartmentId Integer Department identifier.
EmployeeId Integer Employee identifier.
WorkAgreementId Integer Work agreement identifier.

Read more about filters and sorting on how to use sortable parameters

DepartmentId Integer Department identifier
EmployeeId Integer Employee identifier
WorkAgreementId Integer Work agreement identifier

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<Report>
2
     <Rows>
3
          <Row>
4
               <Employee
Employee

Employee reference

>
5
                    <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
6
                    <LastName
LastName

Last name of employee

>{String}</LastName>
7
                    <FirstName
FirstName

First name of employee

>{String}</FirstName>
8
                    <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
9
               </Employee>
10
               <Department
Department

Department reference. One of the system/fixed account dimensions.

>
11
                    <DepartmentId
DepartmentId

Department identifier

>{Integer}</DepartmentId>
12
                    <Name
Name

Name of department

>{String}</Name>
13
                    <DepartmentLink
DepartmentLink

Finance department reference

>{String}</DepartmentLink>
14
               </Department>
15
               <ScheduledWorkingHours
ScheduledWorkingHours

Total scheduled/expected hours for the employee at given date. These hours is extracted from the work arrangement.

>{Decimal}</ScheduledWorkingHours>
16
               <OvertimeHours
OvertimeHours

Overtime hours for given period, excluding paid out hours

>{Decimal}</OvertimeHours>
17
               <Worked
Worked

Worked for employee during period

>
18
                    <Hours
Hours

Total hours of actual work hours for the work hour log. Sum of ordinary work, overtime and paid leave.

>{Decimal}</Hours>
19
                    <Percentage
Percentage

Worked hours percent of Scheduled working hours

>{Decimal}</Percentage>
20
               </Worked>
21
               <SelfCertification
SelfCertification

Self certification for employee during period

>
22
                    <Hours
Hours

Total self certification hours for the employee in given period

>{Decimal}</Hours>
23
                    <Percent
Percent

Self certification percent of Scheduled working hours

>{Decimal}</Percent>
24
               </SelfCertification>
25
               <SickLeave
SickLeave

Sick leave for employee during period

>
26
                    <Hours
Hours

Total sick leave hours for employee in given period

>{Decimal}</Hours>
27
                    <Percent
Percent

Sick leave percent of Scheduled working hours

>{Decimal}</Percent>
28
               </SickLeave>
29
               <ChildCare
ChildCare

Child care for employee during period

>
30
                    <Hours
Hours

Total child care hours for employee in given period

>{Decimal}</Hours>
31
                    <Percent
Percent

Child care percent of Scheduled working hours

>{Decimal}</Percent>
32
               </ChildCare>
33
               <TotalAbscence
TotalAbscence

Total abscence for employee during period

>
34
                    <Hours
Hours

Total absence hours for employee in given period

>{Decimal}</Hours>
35
                    <Percent
Percent

Total absence percent of Scheduled working hours

>{Decimal}</Percent>
36
               </TotalAbscence>
37
               <Inspect>
38
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>
39
               </Inspect>
40
          </Row>
41
     </Rows>
42
     <Aggregated
Aggregated

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

>
43
          <ScheduledWorkingHours
ScheduledWorkingHours

Total scheduled/expected hours for the employee at given date. These hours is extracted from the work arrangement.

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

>{Decimal}</ScheduledWorkingHours>
44
          <OvertimeHours
OvertimeHours

Overtime hours for given period, excluding paid out hours

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

>{Decimal}</OvertimeHours>
45
          <Worked
Worked

Worked for employee during period

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

>
46
               <Hours
Hours

Total hours of actual work hours for the work hour log. Sum of ordinary work, overtime and paid leave.

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

>{Decimal}</Hours>
47
               <Percentage
Percentage

Worked hours percent of Scheduled working hours

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

>{Decimal}</Percentage>
48
          </Worked>
49
          <SelfCertification
SelfCertification

Self certification for employee during period

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

>
50
               <Hours
Hours

Total self certification hours for the employee in given period

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

>{Decimal}</Hours>
51
               <Percent
Percent

Self certification percent of Scheduled working hours

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

>{Decimal}</Percent>
52
          </SelfCertification>
53
          <SickLeave
SickLeave

Sick leave for employee during period

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

>
54
               <Hours
Hours

Total sick leave hours for employee in given period

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

>{Decimal}</Hours>
55
               <Percent
Percent

Sick leave percent of Scheduled working hours

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

>{Decimal}</Percent>
56
          </SickLeave>
57
          <ChildCare
ChildCare

Child care for employee during period

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

>
58
               <Hours
Hours

Total child care hours for employee in given period

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

>{Decimal}</Hours>
59
               <Percent
Percent

Child care percent of Scheduled working hours

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

>{Decimal}</Percent>
60
          </ChildCare>
61
          <TotalAbscence
TotalAbscence

Total abscence for employee during period

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

>
62
               <Hours
Hours

Total absence hours for employee in given period

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

>{Decimal}</Hours>
63
               <Percent
Percent

Total absence percent of Scheduled working hours

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

>{Decimal}</Percent>
64
          </TotalAbscence>
65
     </Aggregated>
66
     <Paging
Paging

Detailed paging information for this list.

>
67
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
68
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
69
          <Page
Page

Page index

>{Integer}</Page>
70
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
71
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
72
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
73
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
74
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
75
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
76
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
77
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
78
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
79
     </Paging>
80
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "employee
Employee

Employee reference

": {
6
                         "employeeId
EmployeeId

Employee identifier

": "{Integer}",
7
                         "lastName
LastName

Last name of employee

": "{String}",
8
                         "firstName
FirstName

First name of employee

": "{String}",
9
                         "employeeLink
EmployeeLink

Employee reference

": "{String}"
10
                    },
11
                    "department
Department

Department reference. One of the system/fixed account dimensions.

": {
12
                         "departmentId
DepartmentId

Department identifier

": "{Integer}",
13
                         "name
Name

Name of department

": "{String}",
14
                         "departmentLink
DepartmentLink

Finance department reference

": "{String}"
15
                    },
16
                    "scheduledWorkingHours
ScheduledWorkingHours

Total scheduled/expected hours for the employee at given date. These hours is extracted from the work arrangement.

": "{Decimal}",
17
                    "overtimeHours
OvertimeHours

Overtime hours for given period, excluding paid out hours

": "{Decimal}",
18
                    "worked
Worked

Worked for employee during period

": {
19
                         "hours
Hours

Total hours of actual work hours for the work hour log. Sum of ordinary work, overtime and paid leave.

": "{Decimal}",
20
                         "percentage
Percentage

Worked hours percent of Scheduled working hours

": "{Decimal}"
21
                    },
22
                    "selfCertification
SelfCertification

Self certification for employee during period

": {
23
                         "hours
Hours

Total self certification hours for the employee in given period

": "{Decimal}",
24
                         "percent
Percent

Self certification percent of Scheduled working hours

": "{Decimal}"
25
                    },
26
                    "sickLeave
SickLeave

Sick leave for employee during period

": {
27
                         "hours
Hours

Total sick leave hours for employee in given period

": "{Decimal}",
28
                         "percent
Percent

Sick leave percent of Scheduled working hours

": "{Decimal}"
29
                    },
30
                    "childCare
ChildCare

Child care for employee during period

": {
31
                         "hours
Hours

Total child care hours for employee in given period

": "{Decimal}",
32
                         "percent
Percent

Child care percent of Scheduled working hours

": "{Decimal}"
33
                    },
34
                    "totalAbscence
TotalAbscence

Total abscence for employee during period

": {
35
                         "hours
Hours

Total absence hours for employee in given period

": "{Decimal}",
36
                         "percent
Percent

Total absence percent of Scheduled working hours

": "{Decimal}"
37
                    },
38
                    "inspect": {
39
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

": "{String}"
40
                    }
41
               }
42
          ],
43
          "aggregated
Aggregated

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

": {
44
               "scheduledWorkingHours
ScheduledWorkingHours

Total scheduled/expected hours for the employee at given date. These hours is extracted from the work arrangement.

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

": "{Decimal}",
45
               "overtimeHours
OvertimeHours

Overtime hours for given period, excluding paid out hours

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

": "{Decimal}",
46
               "worked
Worked

Worked for employee during period

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

": {
47
                    "hours
Hours

Total hours of actual work hours for the work hour log. Sum of ordinary work, overtime and paid leave.

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

": "{Decimal}",
48
                    "percentage
Percentage

Worked hours percent of Scheduled working hours

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

": "{Decimal}"
49
               },
50
               "selfCertification
SelfCertification

Self certification for employee during period

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

": {
51
                    "hours
Hours

Total self certification hours for the employee in given period

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

": "{Decimal}",
52
                    "percent
Percent

Self certification percent of Scheduled working hours

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

": "{Decimal}"
53
               },
54
               "sickLeave
SickLeave

Sick leave for employee during period

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

": {
55
                    "hours
Hours

Total sick leave hours for employee in given period

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

": "{Decimal}",
56
                    "percent
Percent

Sick leave percent of Scheduled working hours

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

": "{Decimal}"
57
               },
58
               "childCare
ChildCare

Child care for employee during period

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

": {
59
                    "hours
Hours

Total child care hours for employee in given period

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

": "{Decimal}",
60
                    "percent
Percent

Child care percent of Scheduled working hours

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

": "{Decimal}"
61
               },
62
               "totalAbscence
TotalAbscence

Total abscence for employee during period

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

": {
63
                    "hours
Hours

Total absence hours for employee in given period

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

": "{Decimal}",
64
                    "percent
Percent

Total absence percent of Scheduled working hours

This field is greyed out because it is an expandable field. You have to add $expand=Aggregated in your request URI to get this field

": "{Decimal}"
65
               }
66
          }
67
     }
68
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 104920 HTTP 400 Log text is required
Error 104921 HTTP 400 Invalid log category
Error 101281 HTTP 400 Too many {0} parameters. Maximum is {1}.
Error 100175 HTTP 400 To date must be equal to, or later than from date.
Error 105710 HTTP 400 Invalid output type