Human resource APIs
List of all work periods across all employees
| HTTP method | GET |
| URI | https://api.rambase.net/human-resources/work-periods |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 50 |
| Successful HTTP status code | 200 |
| API resource identifier | 2145, version 16 |
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.
| $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.
| CreatedAt Datetime | Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| 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() |
| EmployeeId Integer | Employee identifier. Available macros: currentUser() |
| EndSite String | Site at end time of work period. |
| EndTime Time | End time of work period or allowance. |
| IsIn Boolean | Type of work period, allowance or adjustment. |
| Note String | Note/comment of the work period, allowance or adjustment. |
| StartSite String | Site at start time of work period. |
| StartTime Time | Start time of work period or allowance. |
| Status Integer | Status of work period, allowance or adjustment. |
| TimeTypeCategory Integer | Category of the time type. |
| WorkDayId Integer | Workday identifier. |
| WorkPeriodId Integer | Work period, allowance or adjustment identifier. |
Read more about filters and sorting on how to use sortable parameters
| CreatedAt Datetime | Date and time of creation |
| 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. |
| EmployeeId Integer | Employee identifier |
| EndSite String | Site at end time of work period |
| EndTime Time | End time of work period or allowance |
| IsIn Boolean | Type of work period, allowance or adjustment. |
| Note String | Note/comment of the work period, allowance or adjustment |
| StartSite String | Site at start time of work period |
| StartTime Time | Start time of work period or allowance |
| Status Integer | Status of work period, allowance or adjustment |
| TimeTypeCategory Integer | Category of the time type |
| WorkDayId Integer | Workday identifier |
| WorkPeriodId Integer | Work period, allowance or adjustment 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.
WorkPeriodId
Work period identifier
>{Integer}</WorkPeriodId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Status
Status of work period, allowance or adjustment
Possible domain values can be found here
>{Integer}</Status>IsIn
Type of work period, allowance or adjustment.
>{Boolean}</IsIn>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>Note
Note/comment of the work period, allowance or adjustment
>{String}</Note>TimeTypeId
Time type identifier
>{Integer}</TimeTypeId>OvertimePercent
Overtime percentage
>{Integer}</OvertimePercent>Category
Category of the time type
Possible domain values can be found here
>{Integer}</Category>Description
Description of the time type
>{String}</Description>TimeTypeLink
Reference to the time type
>{String}</TimeTypeLink>Time
Start time of work period or allowance
>{Time}</Time>Time
End time of work period or allowance
>{Time}</Time>WorkDayId
Workday identifier
>{Integer}</WorkDayId>EmployeeId
Employee identifier
>{Integer}</EmployeeId>EmployeeLink
Employee reference
>{String}</EmployeeLink>WorkDayLink
Work hour log reference
>{String}</WorkDayLink>ShortTermAbsenceId
Short-term absence identifier
>{Integer}</ShortTermAbsenceId>ShortTermAbsenceLink
Short-term absence reference
>{String}</ShortTermAbsenceLink>WorkPeriodLink
Work period, allowance or adjustment reference
>{String}</WorkPeriodLink>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>WorkPeriodId
Work period identifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Status
Status of work period, allowance or adjustment
Possible domain values can be found here
": "{Integer}",IsIn
Type of work period, allowance or adjustment.
": "{Boolean}",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}",Note
Note/comment of the work period, allowance or adjustment
": "{String}",TimeTypeId
Time type identifier
": "{Integer}",OvertimePercent
Overtime percentage
": "{Integer}",Category
Category of the time type
Possible domain values can be found here
": "{Integer}",Description
Description of the time type
": "{String}",TimeTypeLink
Reference to the time type
": "{String}"Time
Start time of work period or allowance
": "{Time}",Site
Site at start time of work period
Possible domain values can be found here
": "{String}"Time
End time of work period or allowance
": "{Time}",Site
Site at end time of work period
Possible domain values can be found here
": "{String}"WorkDayId
Workday identifier
": "{Integer}",EmployeeId
Employee identifier
": "{Integer}",EmployeeLink
Employee reference
": "{String}"WorkDayLink
Work hour log reference
": "{String}"ShortTermAbsenceId
Short-term absence identifier
": "{Integer}",ShortTermAbsenceLink
Short-term absence reference
": "{String}"WorkPeriodLink
Work period, allowance or adjustment 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 100136 HTTP 404 | Settings and Configuration Values (SCV) with these parameters not found |