Base APIs
Country details for the provided identifier
| HTTP method | GET |
| URI | https://api.rambase.net/base/countries/{countryId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {countryId} |
Country identifier
Integer, minimum 10000 |
| Successful HTTP status code | 200 |
| API resource identifier | 470, version 6 |
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. |
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.
CountryId
Country identifier
>{Integer}</CountryId>Name
Name of country
>{String}</Name>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>Status
Status of country
>{Integer}</Status>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>Area
Name of an area to which the country belongs to according to UN M49 standard
Possible domain values can be found here
>{String}</Area>HasAddressRegion
True if this country has region/state in addresses. This means that region is required when adding addresses from this country.
HasPostalCodeDefinitions
True if RamBase contains a set of postal codes for this country. You can get a list of these postal codes using resources for postal code definitions (under base). Note that if this value is true, you don't need to provide city when adding addresses from this country. The name of the city will be added autamatically.
>{Boolean}</HasPostalCodeDefinitions>Type
Abbriviations of an organization a country is member of (ex. EU)
>{String}</Type>CountryId
Country identifier
": "{Integer}",Name
Name of country
": "{String}",CountryCode
Two-character code (ISO 3166) identifying the country.
": "{String}",Status
Status of country
": "{Integer}",Currency
Three character code following the ISO 4217 standard
": "{String}",Area
Name of an area to which the country belongs to according to UN M49 standard
Possible domain values can be found here
": "{String}",HasAddressRegion
True if this country has region/state in addresses. This means that region is required when adding addresses from this country.
HasPostalCodeDefinitions
True if RamBase contains a set of postal codes for this country. You can get a list of these postal codes using resources for postal code definitions (under base). Note that if this value is true, you don't need to provide city when adding addresses from this country. The name of the city will be added autamatically.
": "{Boolean}",Type
Abbriviations of an organization a country is member of (ex. EU)
": "{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 100141 HTTP 404 | Country not found |