API

Human resource APIs

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

Work hour log periods (WHL) Report will by default run for todays date - this can be overruled by using the From- and ToDate-parameters.

Report name Work hour log periods
Report identifier 118690
HTTP method GET
URI https://api.rambase.net/system/reports/118690/result-set?fromDate={fromDate}&toDate={toDate}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 7246, 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
$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$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.

RegisteredAbsence() Named filter Registered absence periods
Date Date Date of the work period, allowance or adjustment . This date might differ from the date of the workday if the period is across midnight. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
DepartmentId Integer Department identifier.
DepartmentName String Name of department.
EmployeeFirstName String First name of employee.
EmployeeId Integer Employee identifier. Available macros: currentUser()
EmployeeLastName String Last name of employee.
EndTime Time The end time of the WHL.
IsIn Boolean Type of work period, allowance or adjustment.
Note String Note/comment of the work period, allowance or adjustment.
StartTime Time The start time of the WHL.
Status Integer Status of workday.
TimeTypeCategory Integer Category of the time type.
TimeTypeDescription String The description of the time type.
TimeTypeId Integer The unique identificator for the time type.
TimeTypeOvertimePercent Integer Overtime percentage.
TotalTime Decimal The difference between WHL.StartTime and WHL.EndTime.

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

Date Date Date of the work period, allowance or adjustment . This date might differ from the date of the workday if the period is across midnight.
DepartmentId Integer Department identifier
DepartmentName String Name of department
EmployeeFirstName String First name of employee
EmployeeId Integer Employee identifier
EmployeeLastName String Last name of employee
EndTime Time The end time of the WHL
IsIn Boolean Type of work period, allowance or adjustment.
Note String Note/comment of the work period, allowance or adjustment
StartTime Time The start time of the WHL
Status Integer Status of workday
TimeTypeCategory Integer Category of the time type
TimeTypeDescription String The description of the time type
TimeTypeId Integer The unique identificator for the time type
TimeTypeOvertimePercent Integer Overtime percentage
TotalTime Decimal The difference between WHL.StartTime and WHL.EndTime.

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
               <Status
Status

Status of work period, allowance or adjustment

Possible domain values can be found here

>{Integer}</Status>
5
               <Note
Note

Note/comment of the work period, allowance or adjustment

>{String}</Note>
6
               <Workday
Workday

Work day

>
7
                    <WorkdayId
WorkdayId

Workday identifier

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

>{Integer}</WorkdayId>
8
                    <Employee
Employee

Employee reference

>
9
                         <EmployeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

>{String}</FirstName>
12
                         <Department
Department

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

>
13
                              <DepartmentId
DepartmentId

Department identifier

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

Name of department

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

Finance department reference

>{String}</DepartmentLink>
16
                         </Department>
17
                         <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
18
                    </Employee>
19
                    <WorkdayLink
WorkdayLink

Work hour log reference

>{String}</WorkdayLink>
20
               </Workday>
21
               <TimeType
TimeType

TimeType reference

>
22
                    <TimeTypeId
TimeTypeId

The unique identificator for the time type

>{Integer}</TimeTypeId>
23
                    <OvertimePercent
OvertimePercent

Overtime percentage

>{Integer}</OvertimePercent>
24
                    <Category
Category

Category of the time type

Possible domain values can be found here

>{Integer}</Category>
25
                    <Description
Description

Description of the time type

>{String}</Description>
26
                    <TimeTypeLink
TimeTypeLink

The unique identificator for the time type

>{String}</TimeTypeLink>
27
               </TimeType>
28
               <Date
Date

Date of the work period, allowance or adjustment . This date might differ from the date of the workday if the period is across midnight.

>{Date}</Date>
29
               <StartTime
StartTime

The start time of the WHL

>{Time}</StartTime>
30
               <EndTime
EndTime

The end time of the WHL

>{Time}</EndTime>
31
               <Total
Total

Total times

>
32
                    <Hours
Hours

Total time, in hours, of the work period, allowance or adjustment. Calculated by subtracting the start time from the end time.

>{Decimal}</Hours>
33
                    <Time
Time

Total time, in hours and minutes, of the period. Calculated by subtracting the start time from the end time.

>{Time}</Time>
34
               </Total>
35
               <Inspect>
36
                    <TargetApplication
TargetApplication

Application reference when inspecting a line in a report.

>{String}</TargetApplication>
37
               </Inspect>
38
          </Row>
39
     </Rows>
40
     <Paging
Paging

Detailed paging information for this list.

>
41
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
44
          <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>
45
          <FirstPage
FirstPage

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

>{String}</FirstPage>
46
          <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>
47
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
48
          <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>
49
          <NextPage
NextPage

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

>{String}</NextPage>
50
          <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>
51
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
53
     </Paging>
54
</Report>
1
{
2
     "report": {
3
          "rows": [
4
               {
5
                    "status
Status

Status of work period, allowance or adjustment

Possible domain values can be found here

": "{Integer}",
6
                    "note
Note

Note/comment of the work period, allowance or adjustment

": "{String}",
7
                    "workday
Workday

Work day

": {
8
                         "workdayId
WorkdayId

Workday identifier

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

": "{Integer}",
9
                         "employee
Employee

Employee reference

": {
10
                              "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

First name of employee

": "{String}",
13
                              "department
Department

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

": {
14
                                   "departmentId
DepartmentId

Department identifier

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

Name of department

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

Finance department reference

": "{String}"
17
                              },
18
                              "employeeLink
EmployeeLink

Employee reference

": "{String}"
19
                         },
20
                         "workdayLink
WorkdayLink

Work hour log reference

": "{String}"
21
                    },
22
                    "timeType
TimeType

TimeType reference

": {
23
                         "timeTypeId
TimeTypeId

The unique identificator for the time type

": "{Integer}",
24
                         "overtimePercent
OvertimePercent

Overtime percentage

": "{Integer}",
25
                         "category
Category

Category of the time type

Possible domain values can be found here

": "{Integer}",
26
                         "description
Description

Description of the time type

": "{String}",
27
                         "timeTypeLink
TimeTypeLink

The unique identificator for the time type

": "{String}"
28
                    },
29
                    "date
Date

Date of the work period, allowance or adjustment . This date might differ from the date of the workday if the period is across midnight.

": "{Date}",
30
                    "startTime
StartTime

The start time of the WHL

": "{Time}",
31
                    "endTime
EndTime

The end time of the WHL

": "{Time}",
32
                    "total
Total

Total times

": {
33
                         "hours
Hours

Total time, in hours, of the work period, allowance or adjustment. Calculated by subtracting the start time from the end time.

": "{Decimal}",
34
                         "time
Time

Total time, in hours and minutes, of the period. Calculated by subtracting the start time from the end time.

": "{Time}"
35
                    },
36
                    "inspect": {
37
                         "targetApplication
TargetApplication

Application reference when inspecting a line in a report.

": "{String}"
38
                    }
39
               }
40
          ]
41
     }
42
}

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