API

Base APIs

GET base/companies/setting-definitions

Lists company setting definitions.

HTTP method GET
URI https://api.rambase.net/base/companies/setting-definitions
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 150
Successful HTTP status code 200
API resource identifier 2056, version 16

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.

ChangedBy Integer EmployeeId of the employee making the change.
CompanySettingDefinitionId Integer Company setting definition identifier.
DataType String Allowed values for setting. Used for validation of input from user.
DefaultValue String Default value if setting not set for company.
Description String Descrtiption of the setting definition.
DomainValueList.
Field String 		Fieldname of the DOV.
DomainValueList.
Object String 		Object/archive/context of the values.
IsRequired Boolean Flag if setting is required/must be set before using system. If this is a sub-setting, this settings must be set when the parent setting is turned on. The user must activate this setting (a company setting value must exist for this setting). If a default value is also specified, that will actually be a suggested value, the setting must still be activated.
Key String Setting name used to reference the setting.
MaximumValue Decimal For data type integer or decimal a maximum value can be specified, e.g. if a value range is allowed.
MinimumValue Decimal For data type integer or decimal a minimum value can be specified, e.g. if a value range is allowed.
Name String Short name/description of the setting definition.
ParentCompanySettingDefinitionId Integer Company setting definition identifier.
Status Integer Status of company setting definition.
SubModuleId Integer Submodule identifier.
UpdatePermissionId Integer Permission identifier.
ViewPermissionId Integer Permission identifier.

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

ChangedBy Integer EmployeeId of the employee making the change
CompanySettingDefinitionId Integer Company setting definition identifier
DataType String Allowed values for setting. Used for validation of input from user.
DefaultValue String Default value if setting not set for company
DomainValueList.
Field String 		Fieldname of the DOV
DomainValueList.
Object String 		Object/archive/context of the values
IsRequired Boolean Flag if setting is required/must be set before using system. If this is a sub-setting, this settings must be set when the parent setting is turned on. The user must activate this setting (a company setting value must exist for this setting). If a default value is also specified, that will actually be a suggested value, the setting must still be activated.
Key String Setting name used to reference the setting
MaximumValue Decimal For data type integer or decimal a maximum value can be specified, e.g. if a value range is allowed.
MinimumValue Decimal For data type integer or decimal a minimum value can be specified, e.g. if a value range is allowed.
Name String Short name/description of the setting definition
ParentCompanySettingDefinitionId Integer Company setting definition identifier
Status Integer Status of company setting definition
SubModuleId Integer Submodule identifier
UpdatePermissionId Integer Permission identifier
ViewPermissionId Integer Permission identifier

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
<CompanySettingDefinitions>
2
     <CompanySettingDefinition>
3
          <CompanySettingDefinitionId
CompanySettingDefinitionId

Company setting definition identifier

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

Status of company setting definition

Possible domain values can be found here

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

Setting name used to reference the setting

>{String}</Key>
6
          <Name
Name

Short name/description of the setting definition

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

Descrtiption of the setting definition

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

Default value if setting not set for company

>{String}</DefaultValue>
9
          <DataType
DataType

Allowed values for setting. Used for validation of input from user.

>{String}</DataType>
10
          <MinimumValue
MinimumValue

For data type integer or decimal a minimum value can be specified, e.g. if a value range is allowed.

>{Decimal}</MinimumValue>
11
          <MaximumValue
MaximumValue

For data type integer or decimal a maximum value can be specified, e.g. if a value range is allowed.

>{Decimal}</MaximumValue>
12
          <IsRequired
IsRequired

Flag if setting is required/must be set before using system. If this is a sub-setting, this settings must be set when the parent setting is turned on. The user must activate this setting (a company setting value must exist for this setting). If a default value is also specified, that will actually be a suggested value, the setting must still be activated.

>{Boolean}</IsRequired>
13
          <SubModule>
14
               <SubModuleId
SubModuleId

Submodule identifier

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

Name of the submodule

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

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

>
17
                    <ModuleId
ModuleId

Module identifier

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

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

Name of the module

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

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

Module reference

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

>{String}</ModuleLink>
20
               </Module>
21
               <SubModuleLink
SubModuleLink

Submodule reference

>{String}</SubModuleLink>
22
          </SubModule>
23
          <ParentCompanySettingDefinition>
24
               <CompanySettingDefinitionId
CompanySettingDefinitionId

Company setting definition identifier

>{Integer}</CompanySettingDefinitionId>
25
               <CompanySettingDefinitionLink
CompanySettingDefinitionLink

Company setting definition reference

>{String}</CompanySettingDefinitionLink>
26
          </ParentCompanySettingDefinition>
27
          <DomainValueList>
28
               <Object
Object

Object/archive/context of the values

>{String}</Object>
29
               <Field
Field

Fieldname of the DOV

>{String}</Field>
30
          </DomainValueList>
31
          <ViewPermission>
32
               <PermissionId
PermissionId

Permission identifier. Optional. Set this if the setting is secret, e.g. not visible for customers. NOTE: If the setting is read in an application the user must have this permission if assigned.

>{Integer}</PermissionId>
33
               <Name
Name

Name of the permission

>{String}</Name>
34
               <PermissionLink
PermissionLink

Permission reference

>{String}</PermissionLink>
35
          </ViewPermission>
36
          <UpdatePermission>
37
               <PermissionId
PermissionId

Permission identifier. Required for active settings. User must have this permission to be allowed to update the value of this setting.

>{Integer}</PermissionId>
38
               <Name
Name

Name of the permission

>{String}</Name>
39
               <PermissionLink
PermissionLink

Permission reference

>{String}</PermissionLink>
40
          </UpdatePermission>
41
          <CompanySettingDefinitionLink
CompanySettingDefinitionLink

Company setting definition reference

>{String}</CompanySettingDefinitionLink>
42
     </CompanySettingDefinition>
43
     <Paging
Paging

Detailed paging information for this list.

>
44
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
47
          <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>
48
          <FirstPage
FirstPage

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

>{String}</FirstPage>
49
          <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>
50
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
51
          <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>
52
          <NextPage
NextPage

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

>{String}</NextPage>
53
          <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>
54
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
56
     </Paging>
57
</CompanySettingDefinitions>
1
{
2
     "companySettingDefinitions": [
3
          {
4
               "companySettingDefinitionId
CompanySettingDefinitionId

Company setting definition identifier

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

Status of company setting definition

Possible domain values can be found here

": "{Integer}",
6
               "key
Key

Setting name used to reference the setting

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

Short name/description of the setting definition

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

Descrtiption of the setting definition

": "{String}",
9
               "defaultValue
DefaultValue

Default value if setting not set for company

": "{String}",
10
               "dataType
DataType

Allowed values for setting. Used for validation of input from user.

": "{String}",
11
               "minimumValue
MinimumValue

For data type integer or decimal a minimum value can be specified, e.g. if a value range is allowed.

": "{Decimal}",
12
               "maximumValue
MaximumValue

For data type integer or decimal a maximum value can be specified, e.g. if a value range is allowed.

": "{Decimal}",
13
               "isRequired
IsRequired

Flag if setting is required/must be set before using system. If this is a sub-setting, this settings must be set when the parent setting is turned on. The user must activate this setting (a company setting value must exist for this setting). If a default value is also specified, that will actually be a suggested value, the setting must still be activated.

": "{Boolean}",
14
               "subModule": {
15
                    "subModuleId
SubModuleId

Submodule identifier

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

Name of the submodule

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

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

": {
18
                         "moduleId
ModuleId

Module identifier

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

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

Name of the module

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

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

Module reference

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

": "{String}"
21
                    },
22
                    "subModuleLink
SubModuleLink

Submodule reference

": "{String}"
23
               },
24
               "parentCompanySettingDefinition": {
25
                    "companySettingDefinitionId
CompanySettingDefinitionId

Company setting definition identifier

": "{Integer}",
26
                    "companySettingDefinitionLink
CompanySettingDefinitionLink

Company setting definition reference

": "{String}"
27
               },
28
               "domainValueList": {
29
                    "object
Object

Object/archive/context of the values

": "{String}",
30
                    "field
Field

Fieldname of the DOV

": "{String}"
31
               },
32
               "viewPermission": {
33
                    "permissionId
PermissionId

Permission identifier. Optional. Set this if the setting is secret, e.g. not visible for customers. NOTE: If the setting is read in an application the user must have this permission if assigned.

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

Name of the permission

": "{String}",
35
                    "permissionLink
PermissionLink

Permission reference

": "{String}"
36
               },
37
               "updatePermission": {
38
                    "permissionId
PermissionId

Permission identifier. Required for active settings. User must have this permission to be allowed to update the value of this setting.

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

Name of the permission

": "{String}",
40
                    "permissionLink
PermissionLink

Permission reference

": "{String}"
41
               },
42
               "companySettingDefinitionLink
CompanySettingDefinitionLink

Company setting definition reference

": "{String}"
43
          }
44
     ],
45
     "paging
Paging

Detailed paging information for this list.

": {
46
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
58
     }
59
}

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