API

System APIs

POST system/permissions

Returns all permissions.

HTTP method POST
URI https://api.rambase.net/system/permissions
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 2405, version 4

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>
2
     <Name
Name

Required/mandatory field

Name of the permission

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

Technical description of the permission

This field is optional.

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

This field is optional.

>
5
          <Verb
Verb

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

This field is optional.

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

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

This field is optional.

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

This field is optional.

>
9
          <Url
Url

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

This field is optional.

>{String}</Url>
10
     </FilterAPIResource>
11
</Permission>
1
{
2
     "permission": {
3
          "name
Name

Required/mandatory field

Name of the permission

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

Technical description of the permission

This field is optional.

": "{String}",
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}",
7
               "url
Url

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

This field is optional.

": "{String}"
8
          },
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}"
11
          }
12
     }
13
}

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
<Permission>
2
     <PermissionId
PermissionId

Permission identifier

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

Status of the permission

Possible domain values can be found here

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

Name of the permission

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

Technical description of the permission

>{String}</Description>
6
     <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

Possible domain values can be found here

>{Integer}</RequiredUserLevel>
7
     <Repository>
8
          <Scope
Scope

Scope of the Duty

Possible domain values can be found here

>{String}</Scope>
9
          <IsChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

>{Boolean}</IsChanged>
10
          <ChangedBy
ChangedBy

EmployeeId of the employee making the change

>
11
               <UserId
UserId

User identifier

>{Integer}</UserId>
12
               <UserLink
UserLink

User reference

>{String}</UserLink>
13
          </ChangedBy>
14
          <IsPendingDeployment
IsPendingDeployment

Tells whether this object has been changed locally and is ready to be deployed from the Repository

>{Boolean}</IsPendingDeployment>
15
     </Repository>
16
     <FieldAPIResource>
17
          <Verb
Verb

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

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

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

>{String}</Url>
19
     </FieldAPIResource>
20
     <FilterAPIResource>
21
          <Url
Url

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

>{String}</Url>
22
     </FilterAPIResource>
23
</Permission>
1
{
2
     "permission": {
3
          "permissionId
PermissionId

Permission identifier

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

Status of the permission

Possible domain values can be found here

": "{Integer}",
5
          "name
Name

Name of the permission

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

Technical description of the permission

": "{String}",
7
          "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

Possible domain values can be found here

": "{Integer}",
8
          "repository": {
9
               "scope
Scope

Scope of the Duty

Possible domain values can be found here

": "{String}",
10
               "isChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

": "{Boolean}",
11
               "changedBy
ChangedBy

EmployeeId of the employee making the change

": {
12
                    "userId
UserId

User identifier

": "{Integer}",
13
                    "userLink
UserLink

User reference

": "{String}"
14
               },
15
               "isPendingDeployment
IsPendingDeployment

Tells whether this object has been changed locally and is ready to be deployed from the Repository

": "{Boolean}"
16
          },
17
          "fieldAPIResource": {
18
               "verb
Verb

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

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

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

": "{String}"
20
          },
21
          "filterAPIResource": {
22
               "url
Url

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

": "{String}"
23
          }
24
     }
25
}

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