Human resource APIs
Creates a new item in work experience for an employee
HTTP method | POST |
URI | https://api.rambase.net/human-resources/employees/{employeeId}/work-experiences |
Supported formats | Xml, Html, Json (ex. $format=json) |
- URI parameter {employeeId} |
Employee identifier
Integer, minimum 100 |
Successful HTTP status code | 201 |
API resource identifier | 3910, version 2 |
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.
JobTitle
Required/mandatory field
The job title or role the employee had in the company
>{String}</JobTitle>Employer
Name of the company where the employee had this work experience
This field is optional.
>{String}</Employer>Description
Description of the work experience in more detail
This field is optional.
>{String}</Description>StartMonth
Required/mandatory field
The starting month of this work experience
Applicable domain values can be found here
Minimum value: 1
Maximum value: 12
>{Integer}</StartMonth>StartYear
Required/mandatory field
The starting year of this work experience
Minimum value: 1800
>{Integer}</StartYear>EndMonth
The ending month of this work experience
Applicable domain values can be found here
Minimum value: 1
Maximum value: 12
This field is optional.
>{Integer}</EndMonth>EndYear
The ending year of this work experience
Minimum value: 1800
This field is optional.
>{Integer}</EndYear>JobTitle
Required/mandatory field
The job title or role the employee had in the company
": "{String}",Employer
Name of the company where the employee had this work experience
This field is optional.
": "{String}",Description
Description of the work experience in more detail
This field is optional.
": "{String}",StartMonth
Required/mandatory field
The starting month of this work experience
Applicable domain values can be found here
Minimum value: 1
Maximum value: 12
": "{Integer}",StartYear
Required/mandatory field
The starting year of this work experience
Minimum value: 1800
": "{Integer}",EndMonth
The ending month of this work experience
Applicable domain values can be found here
Minimum value: 1
Maximum value: 12
This field is optional.
": "{Integer}",EndYear
The ending year of this work experience
Minimum value: 1800
This field is optional.
": "{Integer}"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.
WorkExperienceId
Employee work experience identifier
>{Integer}</WorkExperienceId>JobTitle
The job title or role the employee had in the company
>{String}</JobTitle>Employer
Name of the company where the employee had this work experience
>{String}</Employer>Description
Description of the work experience in more detail
>{String}</Description>AddedAt
The time and date that the work experience is added
>{Datetime}</AddedAt>StartMonth
The starting month of this work experience
Possible domain values can be found here
>{Integer}</StartMonth>StartYear
The starting year of this work experience
>{Integer}</StartYear>EndMonth
The ending month of this work experience
Possible domain values can be found here
>{Integer}</EndMonth>EndYear
The ending year of this work experience
>{Integer}</EndYear>WorkExperienceId
Employee work experience identifier
": "{Integer}",JobTitle
The job title or role the employee had in the company
": "{String}",Employer
Name of the company where the employee had this work experience
": "{String}",Description
Description of the work experience in more detail
": "{String}",AddedAt
The time and date that the work experience is added
": "{Datetime}",StartMonth
The starting month of this work experience
Possible domain values can be found here
": "{Integer}",StartYear
The starting year of this work experience
": "{Integer}",EndMonth
The ending month of this work experience
Possible domain values can be found here
": "{Integer}",EndYear
The ending year of this work experience
": "{Integer}"
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 101013 HTTP 404 | Sub-module not found |
Error 104915 HTTP 400 | Not a valid start month |
Error 104910 HTTP 400 | Please specify start year |
Error 104911 HTTP 400 | Please specify end year |
Error 104912 HTTP 400 | Please specify end month |
Error 104916 HTTP 400 | Not a valid end month |
Error 104913 HTTP 400 | End year can not be before start year |
Error 104914 HTTP 400 | End month can not be before start month |
Error 103782 HTTP 400 | User is not authorized to add, delete or update education for this employee |