API

Human resource APIs

POST human-resources/competence-profiles/{competenceProfileId}/competence-requirements/{competenceRequirementId}/co-signers

Creates a co-signer of on a competence profile

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

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
<CompetenceCoSigner>
2
     <CoSigner>
3
          <EmployeeId
EmployeeId

Required/mandatory field

Employee identifier

Minimum value: 100

>
{Integer}</EmployeeId>
4
     </CoSigner>
5
</CompetenceCoSigner>
1
{
2
     "competenceCoSigner": {
3
          "coSigner": {
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
<CompetenceCoSigner>
2
     <CompetenceCoSignerId
CompetenceCoSignerId

Competence co-signer identifier

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

Status of the co-signer. 4: Active, 9: Deactivated

Possible domain values can be found here

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

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

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

Date and time for when this competence co-signer was last updated

>
{Datetime}</UpdatedAt>
6
     <CoSigner>
7
          <EmployeeId
EmployeeId

Employee identifier

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

Last name of employee

>
{String}</LastName>
9
          <FirstName
FirstName

First name of employee

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

Employee reference

>
{String}</EmployeeLink>
11
     </CoSigner>
12
</CompetenceCoSigner>
1
{
2
     "competenceCoSigner": {
3
          "competenceCoSignerId
CompetenceCoSignerId

Competence co-signer identifier

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

Status of the co-signer. 4: Active, 9: Deactivated

Possible domain values can be found here

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

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

":
"{Datetime}",
6
          "updatedAt
UpdatedAt

Date and time for when this competence co-signer was last updated

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

Employee identifier

":
"{Integer}",
9
               "lastName
LastName

Last name of employee

":
"{String}",
10
               "firstName
FirstName

First name of employee

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

Employee reference

":
"{String}"
12
          }
13
     }
14
}

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: