Human resource APIs
Self certification details for the provided identifier
HTTP method | GET |
URI | https://api.rambase.net/human-resources/self-certifications/{selfCertificationId} |
Supported formats | Xml, Html, Json (ex. $format=json) |
- URI parameter {selfCertificationId} |
Self certificate identifier
Integer, minimum 100000 |
Successful HTTP status code | 200 |
API resource identifier | 1777, 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.
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.
$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] |
$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 |
$format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
$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. |
$select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select 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.
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 100136 HTTP 404 | Settings and Configuration Values (SCV) with these parameters not found |