Human resource APIs
Lists scheduled work
| HTTP method | GET |
| URI | https://api.rambase.net/human-resources/employees/{employeeId}/work-agreements/scheduled-work-days?fromDate={fromDate} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {employeeId} |
Employee identifier
Integer, minimum 100 |
| Successful HTTP status code | 200 |
| API resource identifier | 3808, version 11 |
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.
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 | Starting date of the date range selection |
| $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.
Read more about filters and sorting on how to use sortable parameters
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.
Date
Date of workday
>{Date}</Date>ScheduledWorkingHours
Total scheduled/expected hours for the employee at given date. These hours is extracted from the work arrangement.
>{Decimal}</ScheduledWorkingHours>LunchHours
Total unpaid lunch, in hours, for all periods in this work hour log. Note that unpaid lunch is only calculated if the sum of work time, overtime and paid leave exceeds 5.5 hours.
>{Decimal}</LunchHours>ScheduledWorkPeriodId
Scheduled work period identifier
>{Integer}</ScheduledWorkPeriodId>StartTime
Start time of scheduled work period
>{Time}</StartTime>EndTime
End time of scheduled work period
>{Time}</EndTime>TotalWorkHours
Total time, in hours, of the work period, allowance or adjustment. Calculated by subtracting the start time from the end time.
>{Decimal}</TotalWorkHours>ScheduledWorkPeriodLink
Scheduled work period reference
>{String}</ScheduledWorkPeriodLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>Date
Date of workday
": "{Date}",ScheduledWorkingHours
Total scheduled/expected hours for the employee at given date. These hours is extracted from the work arrangement.
": "{Decimal}",LunchHours
Total unpaid lunch, in hours, for all periods in this work hour log. Note that unpaid lunch is only calculated if the sum of work time, overtime and paid leave exceeds 5.5 hours.
": "{Decimal}",ScheduledWorkPeriodId
Scheduled work period identifier
": "{Integer}",StartTime
Start time of scheduled work period
": "{Time}",EndTime
End time of scheduled work period
": "{Time}",TotalWorkHours
Total time, in hours, of the work period, allowance or adjustment. Calculated by subtracting the start time from the end time.
": "{Decimal}",ScheduledWorkPeriodLink
Scheduled work period reference
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
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 100515 HTTP 404 | Work Scheme not found |
| Error 100511 HTTP 400 | Invalid date |
| Error 100517 HTTP 404 | Work scheme for {0} on {1} not found |
| Error 100536 HTTP 400 | Company is missing country code |
| Error 100537 HTTP 400 | Could not find work arrangements for employee {0} on date {1} |