System APIs
Permission details for provided identifier
| HTTP method | GET |
| 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 | 1896, 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.
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.
PermissionId
Permission identifier
>{Integer}</PermissionId>Name
Name of the permission
>{String}</Name>Description
Technical description of the permission
>{String}</Description>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>IsChanged
Tells whether this object has been changed locally and are ready to be committed to the Repository
>{Boolean}</IsChanged>ChangedBy
EmployeeId of the employee making the change
>UserId
User identifier
>{Integer}</UserId>UserLink
User reference
>{String}</UserLink>IsPendingDeployment
Tells whether this object has been changed locally and is ready to be deployed from the Repository
>{Boolean}</IsPendingDeployment>Verb
Reference to the verb the API resource uses (GET, POST, PUT, DELETE)
>{String}</Verb>Url
Reference to API resource that holds the fields that can be restricted for the permission.
>{String}</Url>Url
Reference to API resource that will be used when building data restrictions on duties.
>{String}</Url>PermissionId
Permission identifier
": "{Integer}",Status
Status of the permission
Possible domain values can be found here
": "{Integer}",Name
Name of the permission
": "{String}",Description
Technical description of the permission
": "{String}",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}",Scope
Scope of the Duty
Possible domain values can be found here
": "{String}",IsChanged
Tells whether this object has been changed locally and are ready to be committed to the Repository
": "{Boolean}",ChangedBy
EmployeeId of the employee making the change
": {UserId
User identifier
": "{Integer}",UserLink
User reference
": "{String}"IsPendingDeployment
Tells whether this object has been changed locally and is ready to be deployed from the Repository
": "{Boolean}"Verb
Reference to the verb the API resource uses (GET, POST, PUT, DELETE)
": "{String}",Url
Reference to API resource that holds the fields that can be restricted for the permission.
": "{String}"Url
Reference to API resource that will be used when building data restrictions on duties.
": "{String}"
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 101814 HTTP 404 | Employee not found |