System APIs
Updates a main data on a specific role
| HTTP method | PUT |
| 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 | 1917, version 8 |
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.
Role
This field is optional.
>Name
Name of the role
This field is optional.
>{String}</Name>Description
Description of the role
This field is optional.
>{String}</Description>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
Applicable domain values can be found here
This field is optional.
>{Integer}</RequiredUserLevel>RequiredModule
This field is optional.
>ModuleId
Module identifier
Minimum value: 100000
This field is optional.
>{Integer}</ModuleId>Role
This field is optional.
": {Name
Name of the role
This field is optional.
": "{String}",Description
Description of the role
This field is optional.
": "{String}",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
Applicable domain values can be found here
This field is optional.
": "{Integer}",RequiredModule
This field is optional.
": {ModuleId
Module identifier
Minimum value: 100000
This field is optional.
": "{Integer}"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.
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 101606 HTTP 404 | Module not found |
| Error 104417 HTTP 403 | You are not permitted to set this user level |
| Error 108042 HTTP 400 | This required user level can only be assigned in development systems |
| Error 104721 HTTP 403 | The role has duties with user level that is not allowed for the new user level specified on the role |
| Error 104722 HTTP 403 | The role has users with user level that is not allowed for the new user level specified on the role |