Base APIs
Country requirement definition details for provided identifier
| HTTP method | GET |
| 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 | 6265, 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.
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 |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $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. |
| $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. |
| $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. |
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.
CountryRequirementDefinitionId
Country requirement definition identifier
>{Integer}</CountryRequirementDefinitionId>Status
Status of country requirement definition
Possible domain values can be found here
>{Integer}</Status>Key
Country requirement definition key
>{String}</Key>Name
Country requirement definition name
>{String}</Name>Description
Country requirement definition description
>{String}</Description>ObjectType
Object type this requirement definition is for (e.g. ACC)
>{String}</ObjectType>CountryId
Country identifier
>{Integer}</CountryId>Name
Name of country
>{String}</Name>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>CountryLink
Country reference
>{String}</CountryLink>Mode
Indicates where the values for the requirement definition are stored
Possible domain values can be found here
>{String}</Mode>Field
Reference to the field used to fetch possible values
>{String}</Field>Type
Reference to the type used to fetch possible values
>{String}</Type>CountryRequirementDefinitionId
Country requirement definition identifier
>{Integer}</CountryRequirementDefinitionId>CountryRequirementDefinitionLink
Country requirement definition reference
>{String}</CountryRequirementDefinitionLink>CountryRequirementDefinitionId
Country requirement definition identifier
": "{Integer}",Status
Status of country requirement definition
Possible domain values can be found here
": "{Integer}",Key
Country requirement definition key
": "{String}",Name
Country requirement definition name
": "{String}",Description
Country requirement definition description
": "{String}",ObjectType
Object type this requirement definition is for (e.g. ACC)
": "{String}",CountryId
Country identifier
": "{Integer}",Name
Name of country
": "{String}",CountryCode
Two-character code (ISO 3166) identifying the country.
": "{String}",CountryLink
Country reference
": "{String}"Mode
Indicates where the values for the requirement definition are stored
Possible domain values can be found here
": "{String}",Field
Reference to the field used to fetch possible values
": "{String}",Type
Reference to the type used to fetch possible values
": "{String}"CountryRequirementDefinitionId
Country requirement definition identifier
": "{Integer}",CountryRequirementDefinitionLink
Country requirement definition reference
": "{String}"
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 101814 HTTP 404 | Employee not found |