Human resource APIs
Saves/stores details about a short-term absence
| HTTP method | PUT |
| URI | https://api.rambase.net/human-resources/short-term-absences/{shortTermAbsenceId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {shortTermAbsenceId} |
Short-term absence identifier
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 3821, version 3 |
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.
ShortTermAbsence
This field is optional.
>Description
Description that exlplains the reason for the short-term absence
This field is optional.
>{String}</Description>Appointment
This field is optional.
>Regarding
Related entity which initiated the reason for the absence
Applicable domain values can be found here
This field is optional.
>{String}</Regarding>Type
Type of the appointment
Applicable domain values can be found here
This field is optional.
>{String}</Type>Time
Time of the appointment
This field is optional.
>{Time}</Time>Location
Location of the appointment
This field is optional.
>{String}</Location>ShortTermAbsence
This field is optional.
": {Description
Description that exlplains the reason for the short-term absence
This field is optional.
": "{String}",Appointment
This field is optional.
": {Regarding
Related entity which initiated the reason for the absence
Applicable domain values can be found here
This field is optional.
": "{String}",Type
Type of the appointment
Applicable domain values can be found here
This field is optional.
": "{String}",Time
Time of the appointment
This field is optional.
": "{Time}",Location
Location of the appointment
This field is optional.
": "{String}"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. |
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.
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 101818 HTTP 400 | The short-term absence can not be regarding {0} |
| Error 101819 HTTP 400 | Appointment type not valid |
| Error 101820 HTTP 400 | Description is required when appointment type is not specified |
| Error 100511 HTTP 400 | Invalid date |
| Error 100629 HTTP 400 | Please specify a valid time |
| Error 101821 HTTP 400 | Appointment must be in the short-term absence period |