API

Base APIs

GET base/countries/{countryId}/requirement-definitions

Lists country requirement definitions.

HTTP method GET
URI https://api.rambase.net/base/countries/{countryId}/requirement-definitions
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {countryId} Country identifier
Integer, minimum 10000
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 6264, version 15

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.

CountryRequirementDefinitionId Integer Country requirement definition identifier.
Description String Country requirement definition description.
Key String Country requirement definition key.
Name String Country requirement definition name.
ObjectType String Object type this requirement definition is for (e.g. ACC).
ParentCountryRequirementDefinitionId Integer Parent requirement identifier.
Status Integer Status of country requirement definition.
ValueSourceField String Reference to the field used to fetch possible values.
ValueSourceMode String Indicates where the values for the requirement definition are stored.
ValueSourceType String Reference to the type used to fetch possible values.

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

CountryRequirementDefinitionId Integer Country requirement definition identifier
Description String Country requirement definition description
Key String Country requirement definition key
Name String Country requirement definition name
ObjectType String Object type this requirement definition is for (e.g. ACC)
ParentCountryRequirementDefinitionId Integer Parent requirement identifier
Status Integer Status of country requirement definition
ValueSourceField String Reference to the field used to fetch possible values
ValueSourceMode String Indicates where the values for the requirement definition are stored
ValueSourceType String Reference to the type used to fetch possible values

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
<CountryRequirementDefinitions>
2
     <CountryRequirementDefinition>
3
          <CountryRequirementDefinitionId
CountryRequirementDefinitionId

Country requirement definition identifier

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

Status of country requirement definition

Possible domain values can be found here

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

Country requirement definition key

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

Country requirement definition name

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

Country requirement definition description

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

Object type this requirement definition is for (e.g. ACC)

>{String}</ObjectType>
9
          <ValueSource>
10
               <Mode
Mode

Indicates where the values for the requirement definition are stored

Possible domain values can be found here

>{String}</Mode>
11
               <Field
Field

Reference to the field used to fetch possible values

>{String}</Field>
12
               <Type
Type

Reference to the type used to fetch possible values

>{String}</Type>
13
          </ValueSource>
14
          <ParentCountryRequirementDefinition>
15
               <CountryRequirementDefinitionId
CountryRequirementDefinitionId

Country requirement definition identifier

>{Integer}</CountryRequirementDefinitionId>
16
               <CountryRequirementDefinitionLink
CountryRequirementDefinitionLink

Country requirement definition reference

>{String}</CountryRequirementDefinitionLink>
17
          </ParentCountryRequirementDefinition>
18
          <CountryRequirementDefinitionLink
CountryRequirementDefinitionLink

Country requirement definition reference

>{String}</CountryRequirementDefinitionLink>
19
     </CountryRequirementDefinition>
20
     <Paging
Paging

Detailed paging information for this list.

>
21
          <PageSize
PageSize

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

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

Position of the first element in the list

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

Page index

>{Integer}</Page>
24
          <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>
25
          <FirstPage
FirstPage

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

>{String}</FirstPage>
26
          <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>
27
          <PreviousPage
PreviousPage

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

>{String}</PreviousPage>
28
          <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>
29
          <NextPage
NextPage

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

>{String}</NextPage>
30
          <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>
31
          <LastPage
LastPage

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

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

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

>{Integer}</Size>
33
     </Paging>
34
</CountryRequirementDefinitions>
1
{
2
     "countryRequirementDefinitions": [
3
          {
4
               "countryRequirementDefinitionId
CountryRequirementDefinitionId

Country requirement definition identifier

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

Status of country requirement definition

Possible domain values can be found here

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

Country requirement definition key

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

Country requirement definition name

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

Country requirement definition description

": "{String}",
9
               "objectType
ObjectType

Object type this requirement definition is for (e.g. ACC)

": "{String}",
10
               "valueSource": {
11
                    "mode
Mode

Indicates where the values for the requirement definition are stored

Possible domain values can be found here

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

Reference to the field used to fetch possible values

": "{String}",
13
                    "type
Type

Reference to the type used to fetch possible values

": "{String}"
14
               },
15
               "parentCountryRequirementDefinition": {
16
                    "countryRequirementDefinitionId
CountryRequirementDefinitionId

Country requirement definition identifier

": "{Integer}",
17
                    "countryRequirementDefinitionLink
CountryRequirementDefinitionLink

Country requirement definition reference

": "{String}"
18
               },
19
               "countryRequirementDefinitionLink
CountryRequirementDefinitionLink

Country requirement definition reference

": "{String}"
20
          }
21
     ],
22
     "paging
Paging

Detailed paging information for this list.

": {
23
          "pageSize
PageSize

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

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

Position of the first element in the list

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

Page index

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

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

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

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

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

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

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

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

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

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

": "{Integer}"
35
     }
36
}

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 106438 HTTP 400 SAF-T standard code not found