API

Base APIs

PUT base/countries/{countryId}/requirement-definitions/{requirementDefinitionId}

Update contry requirement definition with provided identifier

HTTP method PUT
URI https://api.rambase.net/base/countries/{countryId}/requirement-definitions/{requirementDefinitionId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {countryId} Country identifier
Integer, minimum 10000
- URI parameter {requirementDefinitionId} Country requirement definition identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 6291, version 10

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
CountryRequirementDefinition

This field is optional.

>
2
     <Key
Key

Country requirement definition key

This field is optional.

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

Country requirement definition name

This field is optional.

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

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

This field is optional.

>{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
CountryRequirementDefinition

This field is optional.

": {
3
          "key
Key

Country requirement definition key

This field is optional.

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

Country requirement definition name

This field is optional.

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

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

This field is optional.

": "{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.

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. 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
1

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
Error 108730 HTTP 400 Requirement definition must be in status 4