ConfiguredDictionaryResponse Object

A request to the Dictionaries service returns a ConfiguredDictionaryResponse object that contains:
  • dictionaries— an array consisting of the configured dictionaries. Each listed dictionary includes information on installation path, type of dictionary, country support and more.
Name Type Description
customDictionary Boolean Indicates if the dictionary is a user-defined dictionary.
True
The dictionary is a custom, user-defined dictionary.
False
The dictionary is not a custom dictionary.
repositoryName String The file name of the dictionary.
path String The location of the dictionary on the server.
vintage String The data vintage from the vendor.
source String The data vendor.
description String The name of the dictionary.
countrySupportInfos, a collection of CountrySupport objects. Each comprising the following elements:
supportedCountries List <String> A list of countries supported by the specified dictionary.
supportedDataTypes List <DataType> Type of data in dictionary. One of the following:
  • POINT
  • STREET
  • POST_CODE_1
  • POST_CODE_2
  • AREA_NAME_1
  • AREA_NAME_2
  • AREA_NAME_3
  • AREA_NAME_4