Platform | Country

Service to manage entities of type 'Country'.

Overview

api/{tenantKey}/{orgKey}/corePatterns/countries

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

All Operations

This service includes the following operations:

GET:
POST:
- POST Countries
PUT:
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

Returns the list of all the entity records available.

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:

api/{tenantKey}/{orgKey}/corePatterns/countries

GET /corePatterns/countries

GET Countries (paged)

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

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

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:

api/{tenantKey}/{orgKey}/corePatterns/countries?page={page}&pageSize={pageSize}

GET /corePatterns/countries?page={page}&pageSize={pageSize}

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:

api/{tenantKey}/{orgKey}/corePatterns/countries/{id}

GET /corePatterns/countries/{id}

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:

api/{tenantKey}/{orgKey}/corePatterns/countries/{countryKey}

GET /corePatterns/countries/{countryKey}

GET Print Country by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/countries/{id}/print?template={template}

GET /corePatterns/countries/{id}/print?template={template}

GET Print Country by key

Prints the specified entity record.

The following elements are required:

countryKey

(string) The key for the country.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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:

api/{tenantKey}/{orgKey}/corePatterns/countries/{countryKey}/print

GET /corePatterns/countries/{countryKey}/print

GET Original Print CountryOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/countries/{id}/printOriginal?template={template}

GET /corePatterns/countries/{id}/printOriginal?template={template}

GET Original Print Country by key

Prints the specified entity record.

The following elements are required:

countryKey

(string) The key for the country.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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:

api/{tenantKey}/{orgKey}/corePatterns/countries/{countryKey}/printOriginal

GET /corePatterns/countries/{countryKey}/printOriginal

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:

api/{tenantKey}/{orgKey}/corePatterns/countries

POST /corePatterns/countries

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:

api/{tenantKey}/{orgKey}/corePatterns/countries/{countryKey}/addressFormat

PUT /corePatterns/countries/{countryKey}/addressFormat

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:

api/{tenantKey}/{orgKey}/corePatterns/countries/{countryKey}/bankAccountMaxLength

PUT /corePatterns/countries/{countryKey}/bankAccountMaxLength

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:

api/{tenantKey}/{orgKey}/corePatterns/countries/{countryKey}/bankAccountMinLength

PUT /corePatterns/countries/{countryKey}/bankAccountMinLength

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:

api/{tenantKey}/{orgKey}/corePatterns/countries/{countryKey}/callingCode

PUT /corePatterns/countries/{countryKey}/callingCode

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:

api/{tenantKey}/{orgKey}/corePatterns/countries/{countryKey}/companyTaxIdMaxLength

PUT /corePatterns/countries/{countryKey}/companyTaxIdMaxLength

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:

api/{tenantKey}/{orgKey}/corePatterns/countries/{countryKey}/companyTaxIdMinLength

PUT /corePatterns/countries/{countryKey}/companyTaxIdMinLength

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:

api/{tenantKey}/{orgKey}/corePatterns/countries/{countryKey}/countryKey

PUT /corePatterns/countries/{countryKey}/countryKey

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:

api/{tenantKey}/{orgKey}/corePatterns/countries/{countryKey}/culture

PUT /corePatterns/countries/{countryKey}/culture

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:

api/{tenantKey}/{orgKey}/corePatterns/countries/{countryKey}/dateFormat

PUT /corePatterns/countries/{countryKey}/dateFormat

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:

api/{tenantKey}/{orgKey}/corePatterns/countries/{countryKey}/eU

PUT /corePatterns/countries/{countryKey}/eU

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:

api/{tenantKey}/{orgKey}/corePatterns/countries/{countryKey}/externalId

PUT /corePatterns/countries/{countryKey}/externalId

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:

api/{tenantKey}/{orgKey}/corePatterns/countries/{countryKey}/externalVersion

PUT /corePatterns/countries/{countryKey}/externalVersion

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:

api/{tenantKey}/{orgKey}/corePatterns/countries/{countryKey}/isActive

PUT /corePatterns/countries/{countryKey}/isActive

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:

api/{tenantKey}/{orgKey}/corePatterns/countries/{countryKey}/isExternallyManaged

PUT /corePatterns/countries/{countryKey}/isExternallyManaged

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:

api/{tenantKey}/{orgKey}/corePatterns/countries/{countryKey}/name

PUT /corePatterns/countries/{countryKey}/name

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:

api/{tenantKey}/{orgKey}/corePatterns/countries/{countryKey}/numberFormat

PUT /corePatterns/countries/{countryKey}/numberFormat

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:

api/{tenantKey}/{orgKey}/corePatterns/countries/{countryKey}/postalCodeMaxLength

PUT /corePatterns/countries/{countryKey}/postalCodeMaxLength

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:

api/{tenantKey}/{orgKey}/corePatterns/countries/{countryKey}/postalCodeMinLength

PUT /corePatterns/countries/{countryKey}/postalCodeMinLength

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:

api/{tenantKey}/{orgKey}/corePatterns/countries/{id}

DELETE /corePatterns/countries/{id}

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:

api/{tenantKey}/{orgKey}/corePatterns/countries/{countryKey}

DELETE /corePatterns/countries/{countryKey}

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