Human resource APIs
Creates new short-term absence for logged employee
| HTTP method | POST |
| URI | https://api.rambase.net/human-resources/short-term-absences |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 3819, 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.
Description
Description that exlplains the reason for the short-term absence
This field is optional.
>{String}</Description>StartedAt
Required/mandatory field
Start time of the short-term absence
>{Datetime}</StartedAt>EndedAt
Required/mandatory field
End time of the short-term absence
>{Datetime}</EndedAt>TimeType
This field is optional.
>TimeTypeId
Time type identifier
Minimum value: 100000
This field is optional.
>{Integer}</TimeTypeId>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>Description
Description that exlplains the reason for the short-term absence
This field is optional.
": "{String}",StartedAt
Required/mandatory field
Start time of the short-term absence
": "{Datetime}",EndedAt
Required/mandatory field
End time of the short-term absence
": "{Datetime}"TimeType
This field is optional.
": {TimeTypeId
Time type identifier
Minimum value: 100000
This field is optional.
": "{Integer}"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. |
| $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] |
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.
ShortTermAbsenceId
Short-term absence identifier
>{Integer}</ShortTermAbsenceId>Status
Status of short-term absence
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>SignedAt
Time when the signature is placed in
>{Datetime}</SignedAt>Description
Description that exlplains the reason for the short-term absence
>{String}</Description>EmployeeId
Employee identifier
>{Integer}</EmployeeId>EmployeeLink
Employee reference
>{String}</EmployeeLink>StartedAt
Start time of the short-term absence
>{Datetime}</StartedAt>EndedAt
End time of the short-term absence
>{Datetime}</EndedAt>TimeTypeId
Time type identifier
>{Integer}</TimeTypeId>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>Regarding
Related entity which initiated the reason for the absence
Possible domain values can be found here
>{String}</Regarding>Time
Time of the appointment
>{Time}</Time>Location
Location of the appointment
>{String}</Location>ShortTermAbsenceId
Short-term absence identifier
": "{Integer}",Status
Status of short-term absence
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",SignedAt
Time when the signature is placed in
": "{Datetime}",Description
Description that exlplains the reason for the short-term absence
": "{String}",EmployeeId
Employee identifier
": "{Integer}",EmployeeLink
Employee reference
": "{String}"StartedAt
Start time of the short-term absence
": "{Datetime}",EndedAt
End time of the short-term absence
": "{Datetime}"TimeTypeId
Time type identifier
": "{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}"Regarding
Related entity which initiated the reason for the absence
Possible domain values can be found here
": "{String}",Type
Type of the appointment
Possible domain values can be found here
": "{String}",Time
Time of the appointment
": "{Time}",Location
Location of the appointment
": "{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 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 |