API

Base APIs

GET base/companies/current/settings?activeOnly={activeOnly}&search={search}

Lists setting definitions and what values current company has for each setting.

HTTP method GET
URI https://api.rambase.net/base/companies/current/settings?activeOnly={activeOnly}&search={search}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 150
Successful HTTP status code 200
API resource identifier 2038, 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.

search String, optional Search for setting based on key or name (english and specified language).
activeOnly Boolean, optional Only show company settings that are activated for the company.

Default: 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.

CompanySettingId Integer Company setting identifier.
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.
ParentCompanySettingDefinitionId Integer Company setting definition identifier.
SubModuleId Integer Submodule identifier.

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

CompanySettingId Integer Company setting identifier
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
ParentCompanySettingDefinitionId Integer Company setting definition identifier
SubModuleId Integer Submodule 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
<CompanySettings>
2
     <CompanySetting>
3
          <CompanySettingId
CompanySettingId

Company setting identifier

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

Status of the company setting value

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

Company setting value

>{String}</Value>
6
          <CompanySettingDefinition>
7
               <CompanySettingDefinitionId
CompanySettingDefinitionId

Company setting definition identifier

>{Integer}</CompanySettingDefinitionId>
8
               <Key
Key

Setting name used to reference the setting

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

Short name/description of the setting definition

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

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

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

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

Descrtiption of the setting definition

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

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

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

>{String}</TranslatedDescription>
13
               <DefaultValue
DefaultValue

Default value if setting not set for company

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

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

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

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

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

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

>{Decimal}</MaximumValue>
17
               <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>
18
               <NumberOfChildSettings
NumberOfChildSettings

Number of company setting definitions this setting is parent for.

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

>{Integer}</NumberOfChildSettings>
19
               <SubModule>
20
                    <SubModuleId
SubModuleId

Submodule identifier

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

Name of the sub-module

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

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

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

>
23
                         <ModuleId
ModuleId

Module identifier

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

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

Name of the module

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

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

Module reference

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

>{String}</ModuleLink>
26
                    </Module>
27
                    <SubModuleLink
SubModuleLink

Submodule reference

>{String}</SubModuleLink>
28
               </SubModule>
29
               <ParentCompanySettingDefinition>
30
                    <CompanySettingDefinitionId
CompanySettingDefinitionId

Company setting definition identifier

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

Company setting definition link

>{String}</CompanySettingDefinitionLink>
32
               </ParentCompanySettingDefinition>
33
               <DomainValueList>
34
                    <Object
Object

Object/archive/context of the values

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

Fieldname of the DOV

>{String}</Field>
36
               </DomainValueList>
37
               <CompanySettingDefinitionLink
CompanySettingDefinitionLink

Company setting definition link

>{String}</CompanySettingDefinitionLink>
38
          </CompanySettingDefinition>
39
     </CompanySetting>
40
     <Paging
Paging

Detailed paging information for this list.

>
41
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
44
          <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>
45
          <FirstPage
FirstPage

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

>{String}</FirstPage>
46
          <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>
47
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
48
          <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>
49
          <NextPage
NextPage

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

>{String}</NextPage>
50
          <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>
51
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
53
     </Paging>
54
</CompanySettings>
1
{
2
     "companySettings": [
3
          {
4
               "companySettingId
CompanySettingId

Company setting identifier

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

Status of the company setting value

": "{Integer}",
6
               "value
Value

Company setting value

": "{String}",
7
               "companySettingDefinition": {
8
                    "companySettingDefinitionId
CompanySettingDefinitionId

Company setting definition identifier

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

Setting name used to reference the setting

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

Short name/description of the setting definition

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

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

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

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

Descrtiption of the setting definition

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

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

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

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

Default value if setting not set for company

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

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

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

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

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

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

": "{Decimal}",
18
                    "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}",
19
                    "numberOfChildSettings
NumberOfChildSettings

Number of company setting definitions this setting is parent for.

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

": "{Integer}",
20
                    "subModule": {
21
                         "subModuleId
SubModuleId

Submodule identifier

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

Name of the sub-module

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

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

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

": {
24
                              "moduleId
ModuleId

Module identifier

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

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

Name of the module

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

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

Module reference

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

": "{String}"
27
                         },
28
                         "subModuleLink
SubModuleLink

Submodule reference

": "{String}"
29
                    },
30
                    "parentCompanySettingDefinition": {
31
                         "companySettingDefinitionId
CompanySettingDefinitionId

Company setting definition identifier

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

Company setting definition link

": "{String}"
33
                    },
34
                    "domainValueList": {
35
                         "object
Object

Object/archive/context of the values

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

Fieldname of the DOV

": "{String}"
37
                    },
38
                    "companySettingDefinitionLink
CompanySettingDefinitionLink

Company setting definition link

": "{String}"
39
               }
40
          }
41
     ],
42
     "paging
Paging

Detailed paging information for this list.

": {
43
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
55
     }
56
}

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 101012 HTTP 404 Duty not found
Error 102018 HTTP 403 You need permission {0}. Duties with this permission: {1}