API

Human resource APIs

POST human-resources/competencies

Create a new competence

HTTP method POST
URI https://api.rambase.net/human-resources/competencies
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 2972, 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.

Format:
1
<Competence>
2
     <Name
Name

Required/mandatory field

Name of the competence

>{String}</Name>
3
     <Description
Description

A detailed description of the competence.

This field is optional.

>{String}</Description>
4
     <IsCategory
IsCategory

Indicates if a competence is functioning as a category of competencies

Default value: False

This field is optional.

>{Boolean}</IsCategory>
5
     <ParentCompetence
ParentCompetence

The category or subcategory a competence is divided into.

This field is optional.

>
6
          <CompetenceId
CompetenceId

Competence identifier

Minimum value: 100000

This field is optional.

>{Integer}</CompetenceId>
7
     </ParentCompetence>
8
</Competence>
1
{
2
     "competence": {
3
          "name
Name

Required/mandatory field

Name of the competence

": "{String}",
4
          "description
Description

A detailed description of the competence.

This field is optional.

": "{String}",
5
          "isCategory
IsCategory

Indicates if a competence is functioning as a category of competencies

Default value: False

This field is optional.

": "{Boolean}",
6
          "parentCompetence
ParentCompetence

The category or subcategory a competence is divided into.

This field is optional.

": {
7
               "competenceId
CompetenceId

Competence identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
8
          }
9
     }
10
}

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
<Competence>
2
     <CompetenceId
CompetenceId

Competence identifier

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

Status of competence

Possible domain values can be found here

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

Date and time of creation

>{Datetime}</CreatedAt>
5
     <Name
Name

Name of the competence

>{String}</Name>
6
     <Description
Description

A detailed description of the competence.

>{String}</Description>
7
     <IsCategory
IsCategory

Indicates if a competence is functioning as a category of competencies

>{Boolean}</IsCategory>
8
     <HasChildren
HasChildren

Indicates if a competence is a category and has children

>{Boolean}</HasChildren>
9
     <SortIndex
SortIndex

Index to sort the order of competences

>{Integer}</SortIndex>
10
     <ParentCompetence
ParentCompetence

The category or subcategory a competence is divided into.

>
11
          <CompetenceId
CompetenceId

Competence identifier

>{Integer}</CompetenceId>
12
          <CompetenceLink
CompetenceLink

Competence reference

>{String}</CompetenceLink>
13
     </ParentCompetence>
14
</Competence>
1
{
2
     "competence": {
3
          "competenceId
CompetenceId

Competence identifier

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

Status of competence

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "name
Name

Name of the competence

": "{String}",
7
          "description
Description

A detailed description of the competence.

": "{String}",
8
          "isCategory
IsCategory

Indicates if a competence is functioning as a category of competencies

": "{Boolean}",
9
          "hasChildren
HasChildren

Indicates if a competence is a category and has children

": "{Boolean}",
10
          "sortIndex
SortIndex

Index to sort the order of competences

": "{Integer}",
11
          "parentCompetence
ParentCompetence

The category or subcategory a competence is divided into.

": {
12
               "competenceId
CompetenceId

Competence identifier

": "{Integer}",
13
               "competenceLink
CompetenceLink

Competence reference

": "{String}"
14
          }
15
     }
16
}

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 102018 HTTP 403 You need permission {0}. Duties with this permission: {1}