Human resource APIs
Creates new self certification for logged employee
| HTTP method | POST |
| URI | https://api.rambase.net/human-resources/self-certifications |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 3749, version 6 |
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.
StartedAt
Required/mandatory field
The date and time the self certification period started at
>{Datetime}</StartedAt>EndedAt
Required/mandatory field
The last date and time of the self certification period
>{Datetime}</EndedAt>TimeTypeId
Required/mandatory field
Time type identifier
>{Integer}</TimeTypeId>WorkplaceConditions
This field is optional.
>CausedByWorkplace
Caused by conditions at the work place
Applicable domain values can be found here
This field is optional.
>{String}</CausedByWorkplace>PossibleProblems
Description of workplace conditions that might have caused this self certification. Required if it is caused by workplace .
This field is optional.
>{String}</PossibleProblems>SuggestedMeasures
Description of possible measures at your workplace to prevent future sick leaves. Remedies, organization, work tasks, working hours and so on. Required if sick leave is caused by workplace.
This field is optional.
>{String}</SuggestedMeasures>Actions
Filled out when absence is caused by workplace. Explains what actions the employer has done to improve conditions.
This field is optional.
>{String}</Actions>SickChild
If the self-certified sick leave is related to your child, name and birth year of ill child is required. This is because you are only allowed to self-certify sick leave if the child is less than 12 years old
This field is optional.
>Name
Name of child. Required if the self-certified sick leave is related to your child.
This field is optional.
>{String}</Name>BirthDate
Birth year of child. Required if the self-certified sick leave is related to your child.
This field is optional.
>{Date}</BirthDate>StartedAt
Required/mandatory field
The date and time the self certification period started at
": "{Datetime}",EndedAt
Required/mandatory field
The last date and time of the self certification period
": "{Datetime}"TimeTypeId
Required/mandatory field
Time type identifier
": "{Integer}"WorkplaceConditions
This field is optional.
": {CausedByWorkplace
Caused by conditions at the work place
Applicable domain values can be found here
This field is optional.
": "{String}",PossibleProblems
Description of workplace conditions that might have caused this self certification. Required if it is caused by workplace .
This field is optional.
": "{String}",SuggestedMeasures
Description of possible measures at your workplace to prevent future sick leaves. Remedies, organization, work tasks, working hours and so on. Required if sick leave is caused by workplace.
This field is optional.
": "{String}",Actions
Filled out when absence is caused by workplace. Explains what actions the employer has done to improve conditions.
This field is optional.
": "{String}"SickChild
If the self-certified sick leave is related to your child, name and birth year of ill child is required. This is because you are only allowed to self-certify sick leave if the child is less than 12 years old
This field is optional.
": {Name
Name of child. Required if the self-certified sick leave is related to your child.
This field is optional.
": "{String}",BirthDate
Birth year of child. Required if the self-certified sick leave is related to your child.
This field is optional.
": "{Date}"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.
SelfCertificationId
Self certificate identifier
>{Integer}</SelfCertificationId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>SignedDate
Date of signing
>{Date}</SignedDate>StartedAt
The date and time the self certification period started at
>{Datetime}</StartedAt>EndedAt
The last date and time of the self certification period
>{Datetime}</EndedAt>EmployeeId
Employee identifier
>{Integer}</EmployeeId>EmployeeLink
Employee reference
>{String}</EmployeeLink>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>CausedByWorkplace
Caused by conditions at the work place
Possible domain values can be found here
>{String}</CausedByWorkplace>PossibleProblems
Description of workplace conditions that might have caused this self certification. Required if it is caused by workplace .
>{String}</PossibleProblems>SuggestedMeasures
Description of possible measures at your workplace to prevent future sick leaves. Remedies, organization, work tasks, working hours and so on. Required if sick leave is caused by workplace.
>{String}</SuggestedMeasures>Actions
Filled out when absence is caused by workplace. Explains what actions the employer has done to improve conditions.
>{String}</Actions>SickChild
If the self-certified sick leave is related to your child, name and birth year of ill child is required. This is because you are only allowed to self-certify sick leave if the child is less than 12 years old
>Name
Name of child. Required if the self-certified sick leave is related to your child.
>{String}</Name>BirthDate
Birth year of child. Required if the self-certified sick leave is related to your child.
>{Date}</BirthDate>SelfCertificationId
Self certificate identifier
": "{Integer}",Status
Status of self certificate
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",SignedDate
Date of signing
": "{Date}",StartedAt
The date and time the self certification period started at
": "{Datetime}",EndedAt
The last date and time of the self certification period
": "{Datetime}"EmployeeId
Employee identifier
": "{Integer}",EmployeeLink
Employee reference
": "{String}"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}"CausedByWorkplace
Caused by conditions at the work place
Possible domain values can be found here
": "{String}",PossibleProblems
Description of workplace conditions that might have caused this self certification. Required if it is caused by workplace .
": "{String}",SuggestedMeasures
Description of possible measures at your workplace to prevent future sick leaves. Remedies, organization, work tasks, working hours and so on. Required if sick leave is caused by workplace.
": "{String}",Actions
Filled out when absence is caused by workplace. Explains what actions the employer has done to improve conditions.
": "{String}"SickChild
If the self-certified sick leave is related to your child, name and birth year of ill child is required. This is because you are only allowed to self-certify sick leave if the child is less than 12 years old
": {Name
Name of child. Required if the self-certified sick leave is related to your child.
": "{String}",BirthDate
Birth year of child. Required if the self-certified sick leave is related to your child.
": "{Date}"
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 100578 HTTP 404 | Workday not found |
| Error 104674 HTTP 400 | Please specify how to adapt your workplace |
| Error 104675 HTTP 400 | Please specify to-date |
| Error 104676 HTTP 400 | Please specify from-time |
| Error 104677 HTTP 400 | Please specify to-time |
| Error 104678 HTTP 400 | Not a valid from-date |
| Error 104679 HTTP 400 | Not a valid to-date |
| Error 104680 HTTP 400 | To-date can not be before from-date |
| Error 104681 HTTP 400 | Time from must be before time to |
| Error 104682 HTTP 400 | Self-certifications cannot exceed {0} days without a doctors statement. |
| Error 104683 HTTP 400 | You can not add self-certifications to future periods |
| Error 100481 HTTP 404 | Time type not found |
| Error 104684 HTTP 400 | The given from-date does not contain any lines that requires SLC |
| Error 104685 HTTP 400 | Not a valid from-time |
| Error 104686 HTTP 400 | Not a valid to-time |
| Error 104687 HTTP 400 | Please specify if this sickleave is caused by conditions at the work place |
| Error 104688 HTTP 400 | Please specify the childs name |
| Error 104689 HTTP 400 | Please specify the childs birthday |
| Error 104690 HTTP 400 | Not a valid birthday |
| Error 104691 HTTP 400 | You cannot use childcare when the child is born before {0} |
| Error 104692 HTTP 400 | {0} already has a SLC |
| Error 104693 HTTP 400 | All days must have periods with the same timetype |
| Error 104694 HTTP 400 | You can not have multiple periods the same day |
| Error 104695 HTTP 400 | You cannot have multiple periods that needs SLC on the same day |