API

System APIs

GET system/duties

List of all duties

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

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.

CompanyDefinedDuties() Named filter Duties created locally in current company
DisabledForCompany() Named filter Duties that have been manually disabled for company
EnabledForCompany() Named filter Duty is enabled for current company
NewAndActive() Named filter New and active duties. Status less than 9.
PartnerUsers() Named filter Duties for partner consultants
PortalUsers() Named filter Duties for portal users
StandardUsers() Named filter Duties for standard users
SubmoduleIsEnabled() Named filter Duties linked to a submodule that is activated for current company
SystemDefinedDuties() Named filter System defined duties
Description String Description of the duty.
DutyId Integer Duty identifier.
ModuleName String Name of the module.
Name String Name of the duty.
RequiredUserLevel Integer 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.
Scope String Scope of the Duty.
Status Integer Status of the duty.
SubModuleName String Name of the sub-module.

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

Description String Description of the duty
DutyId Integer Duty identifier
ModuleName String Name of the module
Name String Name of the duty
RequiredUserLevel Integer 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
Scope String Scope of the Duty
Status Integer Status of the duty
SubModuleName String Name of the sub-module

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
<Duties>
2
     <Duty>
3
          <DutyId
DutyId

Duty identifier

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

Status of the duty

Possible domain values can be found here

>{Integer}</Status>
5
          <CompanyStatus
CompanyStatus

Status of the duty 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=Duty.CompanyStatus in your request URI to get this field

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

Name of the duty

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

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

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

Description of the duty

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

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

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

Scope of the Duty

>{String}</Scope>
14
          </Repository>
15
          <SubModule>
16
               <SubModuleId
SubModuleId

Submodule identifier

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

Name of the sub-module

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

Translated name of the submodule. The language used is specified either in $lang or by user settings. If translated name doesn't exist in desired language, english will be used.

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

>{String}</TranslatedName>
19
               <Module
Module

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

>
20
                    <ModuleId
ModuleId

Module identifier

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

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

Name of the module

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

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

Translated name of the module. The language used is specified either in $lang or by user settings. If translated name doesn't exist in desired language, english will be used.

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

>{String}</TranslatedName>
23
                    <ModuleLink
ModuleLink

Module reference

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

>{String}</ModuleLink>
24
               </Module>
25
               <SubModuleLink
SubModuleLink

Submodule reference

>{String}</SubModuleLink>
26
          </SubModule>
27
          <DutyLink
DutyLink

Duty reference

>{String}</DutyLink>
28
     </Duty>
29
     <Paging
Paging

Detailed paging information for this list.

>
30
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
33
          <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>
34
          <FirstPage
FirstPage

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

>{String}</FirstPage>
35
          <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>
36
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
37
          <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>
38
          <NextPage
NextPage

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

>{String}</NextPage>
39
          <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>
40
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
42
     </Paging>
43
</Duties>
1
{
2
     "duties": [
3
          {
4
               "dutyId
DutyId

Duty identifier

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

Status of the duty

Possible domain values can be found here

": "{Integer}",
6
               "companyStatus
CompanyStatus

Status of the duty 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=Duty.CompanyStatus in your request URI to get this field

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

Name of the duty

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

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

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

Description of the duty

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

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

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

Scope of the Duty

": "{String}"
15
               },
16
               "subModule": {
17
                    "subModuleId
SubModuleId

Submodule identifier

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

Name of the sub-module

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

Translated name of the submodule. The language used is specified either in $lang or by user settings. If translated name doesn't exist in desired language, english will be used.

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

": "{String}",
20
                    "module
Module

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

": {
21
                         "moduleId
ModuleId

Module identifier

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

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

Name of the module

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

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

Translated name of the module. The language used is specified either in $lang or by user settings. If translated name doesn't exist in desired language, english will be used.

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

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

Module reference

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

": "{String}"
25
                    },
26
                    "subModuleLink
SubModuleLink

Submodule reference

": "{String}"
27
               },
28
               "dutyLink
DutyLink

Duty reference

": "{String}"
29
          }
30
     ],
31
     "paging
Paging

Detailed paging information for this list.

": {
32
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

": "{Integer}",
35
          "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}",
36
          "firstPage
FirstPage

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

": "{String}",
37
          "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}",
38
          "previousPage
PreviousPage

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

": "{String}",
39
          "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}",
40
          "nextPage
NextPage

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

": "{String}",
41
          "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}",
42
          "lastPage
LastPage

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

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

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

": "{Integer}"
44
     }
45
}

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 101013 HTTP 404 Sub-module not found