Framework | Country

Service to manage entities of type 'Country'.

Overview

URL	api/{tenantKey}/{orgKey}/corePatterns/countries
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET Countries (odata)
  • GET Country by identifier
  • GET Country by key
• POST:
  • POST Countries
• PUT:
  • PUT Set IsActive Country
  • PUT Set CountryKey Country
  • PUT Set Name Country
  • PUT Set CallingCode Country
  • PUT Set NumberFormat Country
  • PUT Set AddressFormat Country
  • PUT Set EU Country
  • PUT Set ExternalId Country
  • PUT Set ExternalVersion Country
  • PUT Set IsExternallyManaged Country
  • PUT Set Culture Country
  • PUT Set DateFormat Country
  • PUT Set BankAccountMinLength Country
  • PUT Set BankAccountMaxLength Country
  • PUT Set PostalCodeMinLength Country
  • PUT Set PostalCodeMaxLength Country
  • PUT Set CompanyTaxIdMinLength Country
  • PUT Set CompanyTaxIdMaxLength Country
• DELETE:
  • DELETE Country by identifier
  • DELETE Country by key

All Resources

This service uses the following resources:

• ApiCountryResource
• CountryResource

All Enumerations

This service uses the following enumerations:

• DateFormat

GET Operations

GET Countries (odata)

Returns a page of the list of all the entity records available.

The following elements are optional:

opts	(ODataQueryOptions) OData query option.

Response:

When successful, the response body contains the list of records available. See CountryResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET Country by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See CountryResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

GET Country by key

Returns the entity record that matches the specified key.

The following elements are required:

countryKey

(string) The key for the country.

Response:

When successful, the response body contains the entity record. See CountryResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

POST Operations

POST Countries

Creates a new entity record.

The following elements are required:

countryResource

(ApiCountryResource) The request body should contain the entity record that should be created. See ApiCountryResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiCountryResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Operations

PUT Set AddressFormat Country

Updates the value of attribute 'AddressFormat' in the specified entity record.

The following elements are required:

countryKey	(string) The key for the country.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set BankAccountMaxLength Country

Updates the value of attribute 'BankAccountMaxLength' in the specified entity record.

The following elements are required:

countryKey	(string) The key for the country.
value	(int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set BankAccountMinLength Country

Updates the value of attribute 'BankAccountMinLength' in the specified entity record.

The following elements are required:

countryKey	(string) The key for the country.
value	(int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set CallingCode Country

Updates the value of attribute 'CallingCode' in the specified entity record.

The following elements are required:

countryKey	(string) The key for the country.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set CompanyTaxIdMaxLength Country

Updates the value of attribute 'CompanyTaxIdMaxLength' in the specified entity record.

The following elements are required:

countryKey	(string) The key for the country.
value	(int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set CompanyTaxIdMinLength Country

Updates the value of attribute 'CompanyTaxIdMinLength' in the specified entity record.

The following elements are required:

countryKey	(string) The key for the country.
value	(int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set CountryKey Country

Updates the value of attribute 'CountryKey' in the specified entity record.

The following elements are required:

countryKey	(string) The key for the country.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Culture Country

Updates the value of attribute 'Culture' in the specified entity record.

The following elements are required:

countryKey	(string) The key for the country.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set DateFormat Country

Updates the value of attribute 'DateFormat' in the specified entity record.

The following elements are required:

countryKey	(string) The key for the country.
value	(enum DateFormat) The request body should contain the new value for the attribute. See DateFormat.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set EU Country

Updates the value of attribute 'EU' in the specified entity record.

The following elements are required:

countryKey	(string) The key for the country.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set ExternalId Country

Updates the value of attribute 'ExternalId' in the specified entity record.

The following elements are required:

countryKey	(string) The key for the country.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set ExternalVersion Country

Updates the value of attribute 'ExternalVersion' in the specified entity record.

The following elements are required:

countryKey	(string) The key for the country.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set IsActive Country

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

countryKey	(string) The key for the country.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

PUT Set IsExternallyManaged Country

Updates the value of attribute 'IsExternallyManaged' in the specified entity record.

The following elements are required:

countryKey	(string) The key for the country.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Name Country

Updates the value of attribute 'Name' in the specified entity record.

The following elements are required:

countryKey	(string) The key for the country.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set NumberFormat Country

Updates the value of attribute 'NumberFormat' in the specified entity record.

The following elements are required:

countryKey	(string) The key for the country.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set PostalCodeMaxLength Country

Updates the value of attribute 'PostalCodeMaxLength' in the specified entity record.

The following elements are required:

countryKey	(string) The key for the country.
value	(int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set PostalCodeMinLength Country

Updates the value of attribute 'PostalCodeMinLength' in the specified entity record.

The following elements are required:

countryKey	(string) The key for the country.
value	(int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

DELETE Operations

DELETE Country by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE Country by key

Deletes the entity record that matches the specified key.

The following elements are required:

countryKey

(string) The key for the country.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

Resources

ApiCountryResource

The following elements are required:

countryKey	(string) The key for the country.
name	(string) The country's name.
eU	(bool) EU member.
isExternallyManaged	(bool) Is Externally Managed.
culture	(string) The country’s culture.

The following elements are optional:

callingCode	(string) The country’s calling code.
numberFormat	(string) The country’s number format.
addressFormat	(string) The country’s address format.
externalId	(string) The country’s external identifier.
externalVersion	(string) The country’s external version.
dateFormat	(enum DateFormat) The country’s date format. See DateFormat.
bankAccountMinLength	(int) The Bank Account Min Length.
bankAccountMaxLength	(int) The Bank Account Max Length.
postalCodeMinLength	(int) The Postal Code Min Length.
postalCodeMaxLength	(int) The Postal Code Max Length.
companyTaxIdMinLength	(int) The Company Tax ID Min Length.
companyTaxIdMaxLength	(int) The Company Tax ID Max Length.

CountryResource

The following elements are required:

countryKey	(string) The key for the country.
name	(string) The country's name.
eU	(bool) EU member.
isExternallyManaged	(bool) Is Externally Managed.
culture	(string) The country’s culture. (fk) Allowed value: the natural key of a record of type Culture. These records are accessibly through the Cultures service.

The following elements are optional:

callingCode	(string) The country’s calling code.
numberFormat	(string) The country’s number format.
addressFormat	(string) The country’s address format.
externalId	(string) The country’s external identifier.
externalVersion	(string) The country’s external version.
dateFormat	(enum DateFormat) The country’s date format. See DateFormat.
bankAccountMinLength	(int) The Bank Account Min Length.
bankAccountMaxLength	(int) The Bank Account Max Length.
postalCodeMinLength	(int) The Postal Code Min Length.
postalCodeMaxLength	(int) The Postal Code Max Length.
companyTaxIdMinLength	(int) The Company Tax ID Min Length.
companyTaxIdMaxLength	(int) The Company Tax ID Max Length.

Enumerations

DateFormat

2	DDMMYYYYDOT	DD.MM.YYYY.
3	DDMMYYYYSLASH	DD/MM/YYYY.
4	MMDDYYYYSLASH	MM/DD/YYYY.
5	MMDDYYYYHYPHEN	MM-DD-YYYY.
6	YYYYMMDDHYPHEN	YYYY-MM-DD.
7	YYYYMMDDSLASH	YYYY/MM/DD.
1	DefaultDateFormat