API

Human resource APIs

POST human-resources/competence-profiles/{competenceProfileId}/document-collections

Creates a document collection and connects it to the competence profile

HTTP method POST
URI https://api.rambase.net/human-resources/competence-profiles/{competenceProfileId}/document-collections
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 6352, 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
<ProfileDocumentCollection>
2
     <DocumentCollection>
3
          <DocumentCollectionId
DocumentCollectionId

Required/mandatory field

Identifier of the document collection

Minimum value: 100000

>{Integer}</DocumentCollectionId>
4
     </DocumentCollection>
5
     <CompetenceRequirement
CompetenceRequirement

This field is optional.

>
6
          <ReadWithinDays
ReadWithinDays

The number of days within which the document must be read

Applicable domain values can be found here

Default value: 0

This field is optional.

>{Integer}</ReadWithinDays>
7
          <CoSignRequirement
CoSignRequirement

What type of cosign is required. 0: "No requirement", 1: "Cosign", 2: "Cosign within department"

Applicable domain values can be found here

Default value: 0

This field is optional.

>{Integer}</CoSignRequirement>
8
          <NotifyBy
NotifyBy

What type of method should be used for notifications on this requirement. 1: Mail

Applicable domain values can be found here

Default value: 0

This field is optional.

>{Integer}</NotifyBy>
9
          <ReadFrequencyMonths
ReadFrequencyMonths

The frequency, in months, at which the document must be re-read

Applicable domain values can be found here

Default value: 0

This field is optional.

>{Integer}</ReadFrequencyMonths>
10
          <CompetenceCoSigners
CompetenceCoSigners

This field is optional.

>
11
               <CompetenceCoSigner
CompetenceCoSigner

This field is optional.

>
12
                    <CoSigner
CoSigner

This field is optional.

>
13
                         <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>{Integer}</EmployeeId>
14
                    </CoSigner>
15
               </CompetenceCoSigner>
16
          </CompetenceCoSigners>
17
     </CompetenceRequirement>
18
</ProfileDocumentCollection>
1
{
2
     "profileDocumentCollection": {
3
          "documentCollection": {
4
               "documentCollectionId
DocumentCollectionId

Required/mandatory field

Identifier of the document collection

Minimum value: 100000

": "{Integer}"
5
          },
6
          "competenceRequirement
CompetenceRequirement

This field is optional.

": {
7
               "readWithinDays
ReadWithinDays

The number of days within which the document must be read

Applicable domain values can be found here

Default value: 0

This field is optional.

": "{Integer}",
8
               "coSignRequirement
CoSignRequirement

What type of cosign is required. 0: "No requirement", 1: "Cosign", 2: "Cosign within department"

Applicable domain values can be found here

Default value: 0

This field is optional.

": "{Integer}",
9
               "notifyBy
NotifyBy

What type of method should be used for notifications on this requirement. 1: Mail

Applicable domain values can be found here

Default value: 0

This field is optional.

": "{Integer}",
10
               "readFrequencyMonths
ReadFrequencyMonths

The frequency, in months, at which the document must be re-read

Applicable domain values can be found here

Default value: 0

This field is optional.

": "{Integer}",
11
               "competenceCoSigners
CompetenceCoSigners

This field is optional.

": [
12
                    {
13
                         "coSigner
CoSigner

This field is optional.

": {
14
                              "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

": "{Integer}"
15
                         }
16
                    }
17
               ]
18
          }
19
     }
20
}

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.
$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
1

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: