Human resource APIs
Create new work period. If the period goes over midnight, it will be split into two periods and will return the last one.
| HTTP method | POST |
| URI | https://api.rambase.net/human-resources/work-periods |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 3702, 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.
Source
Source of the period data
Applicable domain values can be found here
This field is optional.
>{String}</Source>Note
Required/mandatory field
Note/comment of the work period, allowance or adjustment
>{String}</Note>IsIn
Required/mandatory field
Type of work period, allowance or adjustment.
Default value: True
>{Boolean}</IsIn>Date
Required/mandatory field
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
Required/mandatory field
Time type identifier
Minimum value: 100000
>{Integer}</TimeTypeId>Start
This field is optional.
>Time
Start time of work period or allowance
This field is optional.
>{Time}</Time>Site
Site at start time of work period
Applicable domain values can be found here
This field is optional.
>{String}</Site>End
This field is optional.
>Time
End time of work period or allowance
This field is optional.
>{Time}</Time>Site
Site at end time of work period
Applicable domain values can be found here
This field is optional.
>{String}</Site>EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
>{Integer}</EmployeeId>Source
Source of the period data
Applicable domain values can be found here
This field is optional.
": "{String}",Note
Required/mandatory field
Note/comment of the work period, allowance or adjustment
": "{String}",IsIn
Required/mandatory field
Type of work period, allowance or adjustment.
Default value: True
": "{Boolean}",Date
Required/mandatory field
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
Required/mandatory field
Time type identifier
Minimum value: 100000
": "{Integer}"Start
This field is optional.
": {Time
Start time of work period or allowance
This field is optional.
": "{Time}",Site
Site at start time of work period
Applicable domain values can be found here
This field is optional.
": "{String}"End
This field is optional.
": {Time
End time of work period or allowance
This field is optional.
": "{Time}",Site
Site at end time of work period
Applicable domain values can be found here
This field is optional.
": "{String}"EmployeeId
Employee identifier
Minimum value: 100
This field is optional.
": "{Integer}"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.
| $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 |
| $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. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
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.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
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 100481 HTTP 404 | Time type not found |
| Error 100511 HTTP 400 | Invalid date |
| Error 100048 HTTP 400 | Parameter {0}: {1} not valid |
| Error 100027 HTTP 400 | Missing mandatory parameter {0} |
| Error 100537 HTTP 400 | Could not find work arrangements for employee {0} on date {1} |
| Error 100087 HTTP 404 | User not found |
| Error 104731 HTTP 400 | Please enter a note |
| Error 104753 HTTP 400 | Please enter a note with at least 3 characters |
| Error 104733 HTTP 400 | Please choose type |
| Error 107741 HTTP 400 | A short-term absence period can not be more than {0} hours |