API

RamBase REST APIs

GET system/roles/{roleId}

Role details for provided identifier

Important: Have you received an email about using a deprecated version of this API resource? Click here to read more about the deprecated version you are using.
HTTP method GET
URI https://api.rambase.net/system/roles/{roleId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {roleId} Role identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 1915, version 22

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
1

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.

$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]
$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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select 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
<Role>
2
     <RoleId
RoleId

Role identifier

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

Status of the role

Possible domain values can be found here

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

Status of the role for current company

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=CompanyStatus in your request URI to get this field

>{Integer}</CompanyStatus>
5
     <Name
Name

Name of the role

>{String}</Name>
6
     <TranslatedName
TranslatedName

Name translated to selected language. If no translation exists for the given langauage, english name will show.

This field is greyed out because it is an expandable field. You have to add $expand=TranslatedName in your request URI to get this field

>{String}</TranslatedName>
7
     <Description
Description

Description of the role

>{String}</Description>
8
     <TranslatedDescription
TranslatedDescription

Description translated to selected language. If no translation exists for the given langauage, english description will show.

This field is greyed out because it is an expandable field. You have to add $expand=TranslatedDescription in your request URI to get this field

>{String}</TranslatedDescription>
9
     <RequiredUserLevel
RequiredUserLevel

The user level required to have this role. Only user having the same level or higher can be assigned.
This field also controls which duties can be added to the role. Only duties with the same level or lower can be added.

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

Possible domain values can be found here

>{Integer}</RequiredUserLevel>
10
     <AdmittanceLevel
AdmittanceLevel

The admittance level a user having only this role would have for the current company. This field is accumulated for the duties (applicable for the company) on the role. The sum of admittance level of all duties a user has will define which price category the user should have.

This field is greyed out because it is an expandable field. You have to add $expand=AdmittanceLevel in your request URI to get this field

>{Integer}</AdmittanceLevel>
11
     <RequiredModule
RequiredModule

This field is greyed out because it is an expandable field. You have to add $expand=RequiredModule in your request URI to get this field

>
12
          <ModuleId
ModuleId

Module identifier

This field is greyed out because it is an expandable field. You have to add $expand=RequiredModule in your request URI to get this field

>{Integer}</ModuleId>
13
          <Name
Name

Name of the module

This field is greyed out because it is an expandable field. You have to add $expand=RequiredModule in your request URI to get this field

>{String}</Name>
14
          <ModuleLink
ModuleLink

Module reference

This field is greyed out because it is an expandable field. You have to add $expand=RequiredModule in your request URI to get this field

>{String}</ModuleLink>
15
     </RequiredModule>
16
     <Repository
Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>
17
          <Scope
Scope

Scope of the Role

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

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

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

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

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

EmployeeId of the employee making the change

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>
20
               <UserId
UserId

User identifier

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

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

User reference

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>{String}</UserLink>
22
          </ChangedBy>
23
          <IsPendingDeployment
IsPendingDeployment

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

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>{Boolean}</IsPendingDeployment>
24
     </Repository>
25
</Role>
1
{
2
     "role": {
3
          "roleId
RoleId

Role identifier

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

Status of the role

Possible domain values can be found here

": "{Integer}",
5
          "companyStatus
CompanyStatus

Status of the role for current company

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=CompanyStatus in your request URI to get this field

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

Name of the role

": "{String}",
7
          "translatedName
TranslatedName

Name translated to selected language. If no translation exists for the given langauage, english name will show.

This field is greyed out because it is an expandable field. You have to add $expand=TranslatedName in your request URI to get this field

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

Description of the role

": "{String}",
9
          "translatedDescription
TranslatedDescription

Description translated to selected language. If no translation exists for the given langauage, english description will show.

This field is greyed out because it is an expandable field. You have to add $expand=TranslatedDescription in your request URI to get this field

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

The user level required to have this role. Only user having the same level or higher can be assigned.
This field also controls which duties can be added to the role. Only duties with the same level or lower can be added.

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

Possible domain values can be found here

": "{Integer}",
11
          "admittanceLevel
AdmittanceLevel

The admittance level a user having only this role would have for the current company. This field is accumulated for the duties (applicable for the company) on the role. The sum of admittance level of all duties a user has will define which price category the user should have.

This field is greyed out because it is an expandable field. You have to add $expand=AdmittanceLevel in your request URI to get this field

": "{Integer}",
12
          "requiredModule
RequiredModule

This field is greyed out because it is an expandable field. You have to add $expand=RequiredModule in your request URI to get this field

": {
13
               "moduleId
ModuleId

Module identifier

This field is greyed out because it is an expandable field. You have to add $expand=RequiredModule in your request URI to get this field

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

Name of the module

This field is greyed out because it is an expandable field. You have to add $expand=RequiredModule in your request URI to get this field

": "{String}",
15
               "moduleLink
ModuleLink

Module reference

This field is greyed out because it is an expandable field. You have to add $expand=RequiredModule in your request URI to get this field

": "{String}"
16
          },
17
          "repository
Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": {
18
               "scope
Scope

Scope of the Role

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

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

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

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

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

EmployeeId of the employee making the change

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": {
21
                    "userId
UserId

User identifier

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

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

User reference

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": "{String}"
23
               },
24
               "isPendingDeployment
IsPendingDeployment

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

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": "{Boolean}"
25
          }
26
     }
27
}

Possible error codes the response might return:

Error 101606 HTTP 404 Module not found
Error 101030 HTTP 404 Role not found