API

RamBase REST APIs

PUT system/permissions/{permissionId}

This resource returns a single permission.

HTTP method PUT
URI https://api.rambase.net/system/permissions/{permissionId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {permissionId} Permission identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 2411, 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
<Permission
Permission

This field is optional.

>
2
     <Name
Name

Name of the permission

This field is optional.

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

Technical description of the permission

This field is optional.

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

The user level required to have a permission. Only users having the same level or higher can have the permission. Therefore a permission can only be added to duties that have the same user level or higher.

User level (highest level first): Administrator, Partner, User, Portal user

Applicable domain values can be found here

This field is optional.

>{Integer}</RequiredUserLevel>
5
     <FieldAPIResource
FieldAPIResource

This field is optional.

>
6
          <Verb
Verb

Reference to the verb the API resource uses (GET, POST, PUT, DELETE)

This field is optional.

>{String}</Verb>
7
          <Url
Url

Reference to API resource that holds the fields that can be restricted for the permission.

This field is optional.

>{String}</Url>
8
     </FieldAPIResource>
9
     <FilterAPIResource
FilterAPIResource

This field is optional.

>
10
          <Url
Url

Reference to API resource that will be used when building data restrictions on duties.

This field is optional.

>{String}</Url>
11
     </FilterAPIResource>
12
</Permission>
1
{
2
     "permission
Permission

This field is optional.

": {
3
          "name
Name

Name of the permission

This field is optional.

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

Technical description of the permission

This field is optional.

": "{String}",
5
          "requiredUserLevel
RequiredUserLevel

The user level required to have a permission. Only users having the same level or higher can have the permission. Therefore a permission can only be added to duties that have the same user level or higher.

User level (highest level first): Administrator, Partner, User, Portal user

Applicable domain values can be found here

This field is optional.

": "{Integer}",
6
          "fieldAPIResource
FieldAPIResource

This field is optional.

": {
7
               "verb
Verb

Reference to the verb the API resource uses (GET, POST, PUT, DELETE)

This field is optional.

": "{String}",
8
               "url
Url

Reference to API resource that holds the fields that can be restricted for the permission.

This field is optional.

": "{String}"
9
          },
10
          "filterAPIResource
FilterAPIResource

This field is optional.

": {
11
               "url
Url

Reference to API resource that will be used when building data restrictions on duties.

This field is optional.

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

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.

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. Fields colored in grey is expandable 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:

Error 101013 HTTP 404 Sub-module not found
Error 100658 HTTP 400 TITLE can not be empty on a menu-item
Error 100661 HTTP 400 Can not move a node to one of its own children
Error 100615 HTTP 400 You can not create menu items in this tree
Error 101015 HTTP 404 Permission not found
Error 107891 HTTP 403 The permission is assigned to duties not allowing this new user level