API

RamBase REST APIs

PUT system/duties/{dutyId}

Update duty with provided identifier

HTTP method PUT
URI https://api.rambase.net/system/duties/{dutyId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {dutyId} Duty identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 2087, version 10

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
<Duty
Duty

This field is optional.

>
2
     <Name
Name

Name of the duty

This field is optional.

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

Description of the duty

This field is optional.

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

The user level required to have a duty. Only users having the same level or higher can have the duty. Therefore a duty can only be added to roles that have the same user level or higher.

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

Applicable domain values can be found here

This field is optional.

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

How much the duty should weigh in regard to calculation of a users price category (for licence invoicing) . This field is accumulated for the duties a user is assigned, and the sum will define which price category the user should have.

Applicable domain values can be found here

This field is optional.

>
{Integer}</AdmittanceLevel>
6
     <SubModule
SubModule

This field is optional.

>
7
          <SubModuleId
SubModuleId

Submodule identifier

Minimum value: 100000

This field is optional.

>
{Integer}</SubModuleId>
8
     </SubModule>
9
</Duty>
1
{
2
     "duty
Duty

This field is optional.

":
{
3
          "name
Name

Name of the duty

This field is optional.

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

Description of the duty

This field is optional.

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

The user level required to have a duty. Only users having the same level or higher can have the duty. Therefore a duty can only be added to roles that have the same user level or higher.

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

Applicable domain values can be found here

This field is optional.

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

How much the duty should weigh in regard to calculation of a users price category (for licence invoicing) . This field is accumulated for the duties a user is assigned, and the sum will define which price category the user should have.

Applicable domain values can be found here

This field is optional.

":
"{Integer}",
7
          "subModule
SubModule

This field is optional.

":
{
8
               "subModuleId
SubModuleId

Submodule identifier

Minimum value: 100000

This field is optional.

":
"{Integer}"
9
          }
10
     }
11
}

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.

Format:
1
1

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 101015 HTTP 404 Permission not found
Error 101079 HTTP 400 Mismatch in size of revision parameters
Error 102949 HTTP 400 Duty must have access points
Error 101427 HTTP 400 Module is required
Error 101013 HTTP 404 Sub-module not found
Error 104416 HTTP 400 User level is required
Error 104417 HTTP 403 You are not permitted to set this user level
Error 107890 HTTP 400 Permission "{0}" has higher required user level than duty.