API

Collaboration APIs

POST collaboration/folders/{folderId}/role-admittances

Creates role admittance

HTTP method POST
URI https://api.rambase.net/collaboration/folders/{folderId}/role-admittances
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {folderId} Folder identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 6648, 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.

Format:
1
<RoleAdmittance>
2
     <Role>
3
          <RoleId
RoleId

Required/mandatory field

Role identifier

Minimum value: 100000

>{Integer}</RoleId>
4
     </Role>
5
     <Duty>
6
          <DutyId
DutyId

Required/mandatory field

Duty identifier

Minimum value: 100000

>{Integer}</DutyId>
7
     </Duty>
8
</RoleAdmittance>
1
{
2
     "roleAdmittance": {
3
          "role": {
4
               "roleId
RoleId

Required/mandatory field

Role identifier

Minimum value: 100000

": "{Integer}"
5
          },
6
          "duty": {
7
               "dutyId
DutyId

Required/mandatory field

Duty identifier

Minimum value: 100000

": "{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.
$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
<RoleAdmittance>
2
     <RoleAdmittanceId
RoleAdmittanceId

Folder role identifier

>{String}</RoleAdmittanceId>
3
     <AddedAt
AddedAt

Date and time when folder role was added to folder.

>{Datetime}</AddedAt>
4
     <Role>
5
          <RoleId
RoleId

Role identifier

>{Integer}</RoleId>
6
          <RoleLink
RoleLink

Role reference

>{String}</RoleLink>
7
     </Role>
8
     <Duty>
9
          <DutyId
DutyId

Duty identifier

>{Integer}</DutyId>
10
          <DutyLink
DutyLink

Duty reference

>{String}</DutyLink>
11
     </Duty>
12
</RoleAdmittance>
1
{
2
     "roleAdmittance": {
3
          "roleAdmittanceId
RoleAdmittanceId

Folder role identifier

": "{String}",
4
          "addedAt
AddedAt

Date and time when folder role was added to folder.

": "{Datetime}",
5
          "role": {
6
               "roleId
RoleId

Role identifier

": "{Integer}",
7
               "roleLink
RoleLink

Role reference

": "{String}"
8
          },
9
          "duty": {
10
               "dutyId
DutyId

Duty identifier

": "{Integer}",
11
               "dutyLink
DutyLink

Duty 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: