API

System APIs

POST system/duties

Create a new duty

HTTP method POST
URI https://api.rambase.net/system/duties
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 2090, version 9

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>
2
     <Name
Name

Required/mandatory field

Name of the duty

>{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
     <SubModule>
6
          <SubModuleId
SubModuleId

Required/mandatory field

Submodule identifier

Minimum value: 100000

>{Integer}</SubModuleId>
7
     </SubModule>
8
</Duty>
1
{
2
     "duty": {
3
          "name
Name

Required/mandatory field

Name of the duty

": "{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
          "subModule": {
7
               "subModuleId
SubModuleId

Required/mandatory field

Submodule identifier

Minimum value: 100000

": "{Integer}"
8
          }
9
     }
10
}

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.
$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]

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.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<Duty>
2
     <DutyId
DutyId

Duty identifier

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

Status of the duty

Possible domain values can be found here

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

Name of the duty

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

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

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

Description of the duty

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

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

>{String}</TranslatedDescription>
8
     <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

Possible domain values can be found here

>{Integer}</RequiredUserLevel>
9
     <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.

Possible domain values can be found here

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

Date and time of creation

>{Datetime}</CreatedAt>
11
     <SubModule>
12
          <SubModuleId
SubModuleId

Submodule identifier

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

Name of the sub-module

>
14
               <ModuleId
ModuleId

Module identifier

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

Name of the module

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

Module reference

>{String}</ModuleLink>
17
          </Name>
18
          <SubModuleLink
SubModuleLink

Submodule reference

>{String}</SubModuleLink>
19
          <Scope
Scope

Scope of the Duty

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

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

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

EmployeeId of the employee making the change

>{Integer}</ChangedBy>
22
          <IsPendingDeployment
IsPendingDeployment

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

>{Boolean}</IsPendingDeployment>
23
     </SubModule>
24
</Duty>
1
{
2
     "duty": {
3
          "dutyId
DutyId

Duty identifier

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

Status of the duty

Possible domain values can be found here

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

Name of the duty

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

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

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

Description of the duty

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

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

": "{String}",
9
          "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

Possible domain values can be found here

": "{Integer}",
10
          "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.

Possible domain values can be found here

": "{Integer}",
11
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
12
          "subModule": {
13
               "subModuleId
SubModuleId

Submodule identifier

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

Name of the sub-module

": {
15
                    "moduleId
ModuleId

Module identifier

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

Name of the module

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

Module reference

": "{String}"
18
               },
19
               "subModuleLink
SubModuleLink

Submodule reference

": "{String}",
20
               "scope
Scope

Scope of the Duty

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

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

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

EmployeeId of the employee making the change

": "{Integer}",
23
               "isPendingDeployment
IsPendingDeployment

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

": "{Boolean}"
24
          }
25
     }
26
}

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.