API

Human resource APIs

POST human-resources/competence-profiles/{competenceProfileId}/employee-assignments

Creates an employee assignment

HTTP method POST
URI https://api.rambase.net/human-resources/competence-profiles/{competenceProfileId}/employee-assignments
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {competenceProfileId} Competence profile identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 6237, version 7

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.

Format:
1
<EmployeeAssignment>
2
     <Employee>
3
          <EmployeeId
EmployeeId

Required/mandatory field

Employee identifier

Minimum value: 100

>
{Integer}</EmployeeId>
4
     </Employee>
5
</EmployeeAssignment>
1
{
2
     "employeeAssignment": {
3
          "employee": {
4
               "employeeId
EmployeeId

Required/mandatory field

Employee identifier

Minimum value: 100

":
"{Integer}"
5
          }
6
     }
7
}

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.

Format:
1
<EmployeeAssignment>
2
     <EmployeeAssignmentId
EmployeeAssignmentId

Competence User Identifier

>
{Integer}</EmployeeAssignmentId>
3
     <Status
Status

Status of Competence User

Possible domain values can be found here

>
{Integer}</Status>
4
     <AssignedAt
AssignedAt

Automatically generated date and time for when this competence co-signer was created

>
{Datetime}</AssignedAt>
5
     <RemovedAt
RemovedAt

Date and time the competence user was removed

>
{Datetime}</RemovedAt>
6
     <Employee>
7
          <EmployeeId
EmployeeId

Employee identifier

>
{Integer}</EmployeeId>
8
          <Email
Email

Email address of the employee

>
{String}</Email>
9
          <EmployeeLink
EmployeeLink

Employee reference

>
{String}</EmployeeLink>
10
          <OrganizationalUnitId
OrganizationalUnitId

Identifier for organizational unit

>
{Integer}</OrganizationalUnitId>
11
          <Title
Title

Title of the organizational unit

>
{String}</Title>
12
     </Employee>
13
</EmployeeAssignment>
1
{
2
     "employeeAssignment": {
3
          "employeeAssignmentId
EmployeeAssignmentId

Competence User Identifier

":
"{Integer}",
4
          "status
Status

Status of Competence User

Possible domain values can be found here

":
"{Integer}",
5
          "assignedAt
AssignedAt

Automatically generated date and time for when this competence co-signer was created

":
"{Datetime}",
6
          "removedAt
RemovedAt

Date and time the competence user was removed

":
"{Datetime}",
7
          "employee": {
8
               "employeeId
EmployeeId

Employee identifier

":
"{Integer}",
9
               "email
Email

Email address of the employee

":
"{String}",
10
               "employeeLink
EmployeeLink

Employee reference

":
"{String}",
11
               "organizationalUnitId
OrganizationalUnitId

Identifier for organizational unit

":
"{Integer}",
12
               "title
Title

Title of the organizational unit

":
"{String}"
13
          }
14
     }
15
}

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: