Human resource APIs
Details for provided work period
| HTTP method | GET |
| URI | https://api.rambase.net/human-resources/work-days/{workDayId}/periods/{workPeriodId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {workDayId} |
Workday identifier
Integer, minimum 100000 |
| - URI parameter {workPeriodId} |
Work period identifier
Integer, minimum 1 |
| Successful HTTP status code | 200 |
| API resource identifier | 3558, version 30 |
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 |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $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. |
| $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. |
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.
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>Note
Note/comment of the work period, allowance or adjustment
>{String}</Note>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>TimeTypeId
Time type identifier
>{Integer}</TimeTypeId>InOut
Type/Direction of the time type. It can be either IN or OUT
Possible domain values can be found here
>{String}</InOut>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>IsTimeEditable
Saying whether the start/end times of the period can be modifed. This value can be changed according to the settings from SCV
TimeTypeLink
Reference to the time type
>{String}</TimeTypeLink>WorkTime
Total work time, in hours, this period. Might differ from total time, depending on lunch break, flex schedule etc.
>{Decimal}</WorkTime>TotalTime
Total time, in hours, of the work period, allowance or adjustment. Calculated by subtracting the start time from the end time.
>{Decimal}</TotalTime>Time
Start time of work period or allowance
>{Time}</Time>Time
End time of work period or allowance
>{Time}</Time>ShortTermAbsenceId
Short-term absence identifier
>{Integer}</ShortTermAbsenceId>ShortTermAbsenceLink
Short-term absence reference
>{String}</ShortTermAbsenceLink>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}",Source
Source of the period data
Possible domain values can be found here
": "{String}",Note
Note/comment of the work period, allowance or adjustment
": "{String}",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}",TimeTypeId
Time type identifier
": "{Integer}",InOut
Type/Direction of the time type. It can be either IN or OUT
Possible domain values can be found here
": "{String}",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}",IsTimeEditable
Saying whether the start/end times of the period can be modifed. This value can be changed according to the settings from SCV
TimeTypeLink
Reference to the time type
": "{String}"WorkTime
Total work time, in hours, this period. Might differ from total time, depending on lunch break, flex schedule etc.
": "{Decimal}",TotalTime
Total time, in hours, of the work period, allowance or adjustment. Calculated by subtracting the start time from the end time.
": "{Decimal}"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}"ShortTermAbsenceId
Short-term absence identifier
": "{Integer}",ShortTermAbsenceLink
Short-term absence reference
": "{String}"
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 |
| Error 100511 HTTP 400 | Invalid date |
| Error 100009 HTTP 400 | Missing required input arguments |
| Error 100578 HTTP 404 | Workday not found |