API

Human resource APIs

GET human-resources/work-time-utilization?groupBy={groupBy}

Shows how logged work hours is utilized by the employees

HTTP method GET
URI https://api.rambase.net/human-resources/work-time-utilization?groupBy={groupBy}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 6203, version 19

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.

groupBy String, optional The work time utilization can be aggregated by date og by month
$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.

BillableHours Decimal Billable hours of work log entry.
Date Date Date of workday. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
DepartmentId Integer Department identifier.
DeviationHours Decimal The difference between an employees logged hours in work hour log, and utilized hours (hours logged in sales project order and production work order).
EmployeeId Integer Employee of the work hour log. Each work hour log has a unique combination of employee and date.
FirstName String First name of employee.
LastName String Last name of employee.
ManHours Decimal Additional manhours in hours.
NumberOfAllowances Decimal Total number of allowances in this work hour log.
OvertimeHours Decimal Total overtime, in hours, of all periods in this work hour log.
ProductionWorkOrderWorkLogTotalHours Decimal Total hours of work in this work period.
ProjectOrderWorkLogTotalHours Decimal Total hours of work log entry.
RegularHours Decimal Total work time, in hours, for all periods in this work hour log..
ScheduledWorkingHours Decimal Total scheduled/expected hours for the employee at given date. These hours is extracted from the work arrangement..
UtilizedHours Decimal The total number of hours used on sales project order and production work order.
UtilizedPercentage Decimal The total number of hours used on sales project order and production work order presented as percentage.
WorkHours Decimal Total hours of actual work hours for the work hour log. Sum of ordinary work, overtime and paid leave.

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

BillableHours Decimal Billable hours of work log entry
Date Date Date of workday
DepartmentId Integer Department identifier
DeviationHours Decimal The difference between an employees logged hours in work hour log, and utilized hours (hours logged in sales project order and production work order)
EmployeeId Integer Employee of the work hour log. Each work hour log has a unique combination of employee and date.
FirstName String First name of employee
LastName String Last name of employee
ManHours Decimal Additional manhours in hours
NumberOfAllowances Decimal Total number of allowances in this work hour log.
OvertimeHours Decimal Total overtime, in hours, of all periods in this work hour log.
ProductionWorkOrderWorkLogTotalHours Decimal Total hours of work in this work period
ProjectOrderWorkLogTotalHours Decimal Total hours of work log entry
RegularHours Decimal Total work time, in hours, for all periods in this work hour log.
ScheduledWorkingHours Decimal Total scheduled/expected hours for the employee at given date. These hours is extracted from the work arrangement.
UtilizedHours Decimal The total number of hours used on sales project order and production work order
UtilizedPercentage Decimal The total number of hours used on sales project order and production work order presented as percentage
WorkHours Decimal Total hours of actual work hours for the work hour log. Sum of ordinary work, overtime and paid leave.

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
<WorkTimeUtilization>
2
     <UtilizationByTimePeriods>
3
          <UtilizationByTimePeriod>
4
               <Employee>
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
                    <Department>
9
                         <DepartmentId
DepartmentId

Department identifier

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

Name of department

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

Finance department reference

>{String}</DepartmentLink>
12
                    </Department>
13
                    <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
14
               </Employee>
15
               <TimePeriod>
16
                    <StartedAt
StartedAt

Date of workday

>{Datetime}</StartedAt>
17
                    <NumberOfAllowances
NumberOfAllowances

Total number of allowances in this work hour log.

>{Decimal}</NumberOfAllowances>
18
                    <ScheduledWorkingHours
ScheduledWorkingHours

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

>{Decimal}</ScheduledWorkingHours>
19
                    <WorkHours
WorkHours

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

>{Decimal}</WorkHours>
20
                    <RegularHours
RegularHours

Total work time, in hours, for all periods in this work hour log.

>{Decimal}</RegularHours>
21
                    <OvertimeHours
OvertimeHours

Total overtime, in hours, of all periods in this work hour log.

>{Decimal}</OvertimeHours>
22
               </TimePeriod>
23
               <Utilization>
24
                    <ProjectOrderWorkLog>
25
                         <TotalHours
TotalHours

Total hours of work log entry

>{Decimal}</TotalHours>
26
                         <BillableHours
BillableHours

Billable hours of work log entry

>{Decimal}</BillableHours>
27
                    </ProjectOrderWorkLog>
28
                    <ProductionWorkOrderWorkLog>
29
                         <ManHours
ManHours

Additional manhours in hours

>{Decimal}</ManHours>
30
                         <TotalHours
TotalHours

Total hours of work in this work period

>{Decimal}</TotalHours>
31
                    </ProductionWorkOrderWorkLog>
32
                    <Totals>
33
                         <UtilizedHours
UtilizedHours

The total number of hours used on sales project order and production work order

>{Decimal}</UtilizedHours>
34
                         <DeviationHours
DeviationHours

The difference between an employees logged hours in work hour log, and utilized hours (hours logged in sales project order and production work order)

>{Decimal}</DeviationHours>
35
                         <UtilizedPercentage
UtilizedPercentage

The total number of hours used on sales project order and production work order presented as percentage

>{Decimal}</UtilizedPercentage>
36
                    </Totals>
37
               </Utilization>
38
          </UtilizationByTimePeriod>
39
     </UtilizationByTimePeriods>
40
     <Totals
Totals

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

>
41
          <WorkHours
WorkHours

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=Totals in your request URI to get this field

>{Decimal}</WorkHours>
42
          <ProjectOrderWorkHours
ProjectOrderWorkHours

Total hours of work log entry

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

>{Decimal}</ProjectOrderWorkHours>
43
          <ProductionWorkOrderHours
ProductionWorkOrderHours

Total hours of work in this work period

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

>{Decimal}</ProductionWorkOrderHours>
44
          <UtilizedHours
UtilizedHours

The total number of hours used on sales project order and production work order

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

>{Decimal}</UtilizedHours>
45
          <DeviationHours
DeviationHours

The difference between an employees logged hours in work hour log, and utilized hours (hours logged in sales project order and production work order)

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

>{Decimal}</DeviationHours>
46
          <UtilizedPercentage
UtilizedPercentage

The total number of hours used on sales project order and production work order presented as percentage

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

>{Decimal}</UtilizedPercentage>
47
     </Totals>
48
     <Paging
Paging

Detailed paging information for this list.

>
49
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
52
          <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>
53
          <FirstPage
FirstPage

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

>{String}</FirstPage>
54
          <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>
55
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
56
          <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>
57
          <NextPage
NextPage

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

>{String}</NextPage>
58
          <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>
59
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
61
     </Paging>
62
</WorkTimeUtilization>
1
{
2
     "workTimeUtilization": {
3
          "utilizationByTimePeriods": [
4
               {
5
                    "employee": {
6
                         "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

": "{String}",
9
                         "department": {
10
                              "departmentId
DepartmentId

Department identifier

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

Name of department

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

Finance department reference

": "{String}"
13
                         },
14
                         "employeeLink
EmployeeLink

Employee reference

": "{String}"
15
                    },
16
                    "timePeriod": {
17
                         "startedAt
StartedAt

Date of workday

": "{Datetime}",
18
                         "numberOfAllowances
NumberOfAllowances

Total number of allowances in this work hour log.

": "{Decimal}",
19
                         "scheduledWorkingHours
ScheduledWorkingHours

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

": "{Decimal}",
20
                         "workHours
WorkHours

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

": "{Decimal}",
21
                         "regularHours
RegularHours

Total work time, in hours, for all periods in this work hour log.

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

Total overtime, in hours, of all periods in this work hour log.

": "{Decimal}"
23
                    },
24
                    "utilization": {
25
                         "projectOrderWorkLog": {
26
                              "totalHours
TotalHours

Total hours of work log entry

": "{Decimal}",
27
                              "billableHours
BillableHours

Billable hours of work log entry

": "{Decimal}"
28
                         },
29
                         "productionWorkOrderWorkLog": {
30
                              "manHours
ManHours

Additional manhours in hours

": "{Decimal}",
31
                              "totalHours
TotalHours

Total hours of work in this work period

": "{Decimal}"
32
                         },
33
                         "totals": {
34
                              "utilizedHours
UtilizedHours

The total number of hours used on sales project order and production work order

": "{Decimal}",
35
                              "deviationHours
DeviationHours

The difference between an employees logged hours in work hour log, and utilized hours (hours logged in sales project order and production work order)

": "{Decimal}",
36
                              "utilizedPercentage
UtilizedPercentage

The total number of hours used on sales project order and production work order presented as percentage

": "{Decimal}"
37
                         }
38
                    }
39
               }
40
          ],
41
          "totals
Totals

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

": {
42
               "workHours
WorkHours

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=Totals in your request URI to get this field

": "{Decimal}",
43
               "projectOrderWorkHours
ProjectOrderWorkHours

Total hours of work log entry

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

": "{Decimal}",
44
               "productionWorkOrderHours
ProductionWorkOrderHours

Total hours of work in this work period

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

": "{Decimal}",
45
               "utilizedHours
UtilizedHours

The total number of hours used on sales project order and production work order

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

": "{Decimal}",
46
               "deviationHours
DeviationHours

The difference between an employees logged hours in work hour log, and utilized hours (hours logged in sales project order and production work order)

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

": "{Decimal}",
47
               "utilizedPercentage
UtilizedPercentage

The total number of hours used on sales project order and production work order presented as percentage

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

": "{Decimal}"
48
          }
49
     }
50
}

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 101814 HTTP 404 Employee not found