API

Base APIs

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

Create a country requirement definition

HTTP method POST
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
Successful HTTP status code 201
API resource identifier 6290, version 8

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
<CountryRequirementDefinition>
2
     <Key
Key

Required/mandatory field

Country requirement definition key

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

Required/mandatory field

Country requirement definition name

>{String}</Name>
4
     <ObjectType
ObjectType

Required/mandatory field

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

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

Country requirement definition description

This field is optional.

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

This field is optional.

>
7
          <Mode
Mode

Indicates where the values for the requirement definition are stored

Applicable domain values can be found here

This field is optional.

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

Reference to the field used to fetch possible values

This field is optional.

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

Reference to the type used to fetch possible values

This field is optional.

>{String}</Type>
10
     </ValueSource>
11
     <ParentCountryRequirementDefinition
ParentCountryRequirementDefinition

This field is optional.

>
12
          <CountryRequirementDefinitionId
CountryRequirementDefinitionId

Country requirement definition identifier

Minimum value: 100000

This field is optional.

>{Integer}</CountryRequirementDefinitionId>
13
     </ParentCountryRequirementDefinition>
14
</CountryRequirementDefinition>
1
{
2
     "countryRequirementDefinition": {
3
          "key
Key

Required/mandatory field

Country requirement definition key

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

Required/mandatory field

Country requirement definition name

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

Required/mandatory field

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

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

Country requirement definition description

This field is optional.

": "{String}",
7
          "valueSource
ValueSource

This field is optional.

": {
8
               "mode
Mode

Indicates where the values for the requirement definition are stored

Applicable domain values can be found here

This field is optional.

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

Reference to the field used to fetch possible values

This field is optional.

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

Reference to the type used to fetch possible values

This field is optional.

": "{String}"
11
          },
12
          "parentCountryRequirementDefinition
ParentCountryRequirementDefinition

This field is optional.

": {
13
               "countryRequirementDefinitionId
CountryRequirementDefinitionId

Country requirement definition identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
14
          }
15
     }
16
}

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

Country requirement definition identifier

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

Status of country requirement definition

Possible domain values can be found here

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

Country requirement definition key

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

Country requirement definition name

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

Country requirement definition description

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

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

>{String}</ObjectType>
8
     <Country>
9
          <CountryId
CountryId

Country identifier

>{Integer}</CountryId>
10
          <Name
Name

Name of country

>{String}</Name>
11
          <CountryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>
12
          <CountryLink
CountryLink

Country reference

>{String}</CountryLink>
13
     </Country>
14
     <ValueSource>
15
          <Mode
Mode

Indicates where the values for the requirement definition are stored

Possible domain values can be found here

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

Reference to the field used to fetch possible values

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

Reference to the type used to fetch possible values

>{String}</Type>
18
     </ValueSource>
19
     <ParentCountryRequirementDefinition>
20
          <CountryRequirementDefinitionId
CountryRequirementDefinitionId

Country requirement definition identifier

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

Country requirement definition reference

>{String}</CountryRequirementDefinitionLink>
22
          <Scope
Scope

Scope of the object. GLOBAL objects is available in all RamBase systems. LOCAL objects is only available in current RamBase system.

Possible domain values can be found here

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

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

>{Boolean}</IsChanged>
24
     </ParentCountryRequirementDefinition>
25
</CountryRequirementDefinition>
1
{
2
     "countryRequirementDefinition": {
3
          "countryRequirementDefinitionId
CountryRequirementDefinitionId

Country requirement definition identifier

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

Status of country requirement definition

Possible domain values can be found here

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

Country requirement definition key

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

Country requirement definition name

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

Country requirement definition description

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

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

": "{String}",
9
          "country": {
10
               "countryId
CountryId

Country identifier

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

Name of country

": "{String}",
12
               "countryCode
CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}",
13
               "countryLink
CountryLink

Country reference

": "{String}"
14
          },
15
          "valueSource": {
16
               "mode
Mode

Indicates where the values for the requirement definition are stored

Possible domain values can be found here

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

Reference to the field used to fetch possible values

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

Reference to the type used to fetch possible values

": "{String}"
19
          },
20
          "parentCountryRequirementDefinition": {
21
               "countryRequirementDefinitionId
CountryRequirementDefinitionId

Country requirement definition identifier

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

Country requirement definition reference

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

Scope of the object. GLOBAL objects is available in all RamBase systems. LOCAL objects is only available in current RamBase system.

Possible domain values can be found here

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

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

": "{Boolean}"
25
          }
26
     }
27
}

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
Error 101551 HTTP 404 Object {0} not found
Error 108724 HTTP 400 Object type is required
Error 108834 HTTP 400 Country requirement definition value mode is required