Human resource APIs
Creates new absence statistics job
| HTTP method | POST |
| URI | https://api.rambase.net/human-resources/absence-statistics-jobs |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 4203, version 12 |
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.
Required/mandatory field
Email address to receive absence statistics file
Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$
>{String}</Email>FileFormat
Format of exported file. Possible values: FRM/10212 - HL- Huldt & Lillevik , FRM/15274 - VP - Visma Payroll
Applicable domain values can be found here
This field is optional.
>{String}</FileFormat>StartDate
Required/mandatory field
Start date that was used to process absence statistics data
>{Date}</StartDate>EndDate
Required/mandatory field
End date that was used to process absence statistics data
>{Date}</EndDate>IncludeChangesSinceLastRun
Include revised or created work logs since the last run
Default value: False
This field is optional.
>{Boolean}</IncludeChangesSinceLastRun>Required/mandatory field
Email address to receive absence statistics file
Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$
": "{String}",FileFormat
Format of exported file. Possible values: FRM/10212 - HL- Huldt & Lillevik , FRM/15274 - VP - Visma Payroll
Applicable domain values can be found here
This field is optional.
": "{String}",StartDate
Required/mandatory field
Start date that was used to process absence statistics data
": "{Date}",EndDate
Required/mandatory field
End date that was used to process absence statistics data
": "{Date}"IncludeChangesSinceLastRun
Include revised or created work logs since the last run
Default value: False
This field is optional.
": "{Boolean}"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 101015 HTTP 404 | Permission not found |
| Error 101420 HTTP 404 | Setting definition not found |
| Error 105246 HTTP 400 | Please specify e-mail |
| Error 103253 HTTP 400 | {0} |