API

System APIs

GET system/roles

Resource for listing roles in the system

HTTP method GET
URI https://api.rambase.net/system/roles
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 1921, version 18

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
$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.
$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.
$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.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

CompanyDefinedRoles() Named filter Roles created locally in current company
DisabledForCompany() Named filter Roles that have been manually disabled for company
EnabledForCompany() Named filter Exclude roles that have been manually disabled for company
NewAndActive() Named filter New and active roles (status less than 9)
PartnerUsers() Named filter Roles for partner consultants
PortalUsers() Named filter Roles for portal users
StandardUsers() Named filter Roles for standard users
SystemDefinedRoles() Named filter System defined roles
ContainingDutyId Integer Duty identifier.
ContainingUserId Integer User identifier.
Description String Description of the role.
Name String Name of the role.
RequiredUserLevel Integer 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.
RoleId Integer Role identifier.
Scope String Scope of the Role.
Status Integer Status of the role.

Read more about filters and sorting on how to use sortable parameters

ContainingDutyId Integer Duty identifier
ContainingUserId Integer User identifier
Description String Description of the role
Name String Name of the role
RequiredUserLevel Integer 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
RoleId Integer Role identifier
Scope String Scope of the Role
Status Integer Status of the role

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
<Roles>
2
     <Role>
3
          <RoleId
RoleId

Role identifier

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

Status of the role

Possible domain values can be found here

>{Integer}</Status>
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=Role.CompanyStatus in your request URI to get this field

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

Name of the role

>{String}</Name>
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=Role.TranslatedName in your request URI to get this field

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

Description of the role

>{String}</Description>
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=Role.TranslatedDescription in your request URI to get this field

>{String}</TranslatedDescription>
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}</RequiredUserLevel>
11
          <Repository>
12
               <Scope
Scope

Scope of the Role

Possible domain values can be found here

>{String}</Scope>
13
          </Repository>
14
          <RoleLink
RoleLink

Role reference

>{String}</RoleLink>
15
     </Role>
16
     <Paging
Paging

Detailed paging information for this list.

>
17
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
18
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
19
          <Page
Page

Page index

>{Integer}</Page>
20
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

>{String}</FirstPageKey>
21
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
22
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

>{String}</PreviousPageKey>
23
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
24
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

>{String}</NextPageKey>
25
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
26
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

>{String}</LastPageKey>
27
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
28
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
29
     </Paging>
30
</Roles>
1
{
2
     "roles": [
3
          {
4
               "roleId
RoleId

Role identifier

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

Status of the role

Possible domain values can be found here

": "{Integer}",
6
               "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=Role.CompanyStatus in your request URI to get this field

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

Name of the role

": "{String}",
8
               "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=Role.TranslatedName in your request URI to get this field

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

Description of the role

": "{String}",
10
               "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=Role.TranslatedDescription in your request URI to get this field

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

Scope of the Role

Possible domain values can be found here

": "{String}"
14
               },
15
               "roleLink
RoleLink

Role reference

": "{String}"
16
          }
17
     ],
18
     "paging
Paging

Detailed paging information for this list.

": {
19
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
20
          "position
Position

Position of the first element in the list

": "{Integer}",
21
          "page
Page

Page index

": "{Integer}",
22
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

": "{String}",
23
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
24
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

": "{String}",
25
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
26
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

": "{String}",
27
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
28
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

": "{String}",
29
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
30
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
31
     }
32
}

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 101030 HTTP 404 Role not found