Overall

Document settings are returned using the following tag structure:

DocumentSettings
- SettingGroups
  - GroupX

Where "GroupX" denotes concrete settings group definition. Below You can find the list of supported groups. Name of each group corresponds to the name of DocumentSettingsGroup enumeration member.

Setting groups

LinguisticReportConfiguration

Tag	Meaning
ConfigurationName	Name of the reporting configuration
Language	The culture name in the format languagecode2-country/regioncode2. languagecode2 is a lowercase two-letter code derived from ISO 639-1. country/regioncode2 is derived from ISO 3166 and usually consists of two uppercase letters. https://msdn.microsoft.com/en-us/library/cc233982.aspx
WordCountFactor	Word count factor
HighRatingLimit	"Safe" release rate threshold
HighRatingName	"Safe" release rate title
MediumRatingLimit	"Acceptable" release rate threshold
MediumRatingName	"Acceptable" release rate title
LowRatingLimit	"Unsafe" release rate threshold
LowRatingName	"Unsafe" release rate title
Rules	Array of RuleOption tags representing error weights
Categories	Array of CategoryOption tags representing rule priorities

RuleOption

Tag	Meaning
RuleName	Name of the rule
CategoryType	Category of the produced error (value of LinguisticErrorType enumeration)
Weight	Rule importance

CategoryOption

Tag	Meaning
ErrorType	Category of the error (value of LinguisticErrorType enumeration)
Priority	Category weight

Sample output

<?xml version="1.0" encoding="utf-16"?>
<DocumentSettings xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <SettingGroups>
    <LinguisticReportConfiguration>
      <ConfigurationName>Congree Standard DE</ConfigurationName>
      <Language>7</Language>
      <WordCountFactor>1.2</WordCountFactor>
      <HighRatingLimit>95</HighRatingLimit>
      <HighRatingName>Safe</HighRatingName>
      <MediumRatingLimit>85</MediumRatingLimit>
      <MediumRatingName>Acceptable</MediumRatingName>
      <LowRatingLimit>0</LowRatingLimit>
      <LowRatingName>Unsafe</LowRatingName>
      <Rules>
        <RuleOption>
          <RuleName>unknown</RuleName>
          <CategoryType>Spelling</CategoryType>
          <Weight>5</Weight>
        </RuleOption>
        <RuleOption>
          <RuleName>DEPR</RuleName>
          <CategoryType>Terminology</CategoryType>
          <Weight>10</Weight>
        </RuleOption>
      </Rules>
      <Categories>
        <CategoryOption>
          <ErrorType>Abbreviation</ErrorType>
          <Priority>1</Priority>
        </CategoryOption>
        <CategoryOption>
          <ErrorType>Spelling</ErrorType>
          <Priority>10</Priority>
        </CategoryOption>
        <CategoryOption>
          <ErrorType>Style</ErrorType>
          <Priority>1</Priority>
        </CategoryOption>
        <CategoryOption>
          <ErrorType>Terminology</ErrorType>
          <Priority>10</Priority>
        </CategoryOption>
        <CategoryOption>
          <ErrorType>Grammar</ErrorType>
          <Priority>3</Priority>
        </CategoryOption>
      </Categories>
    </LinguisticReportConfiguration>
  </SettingGroups>
</DocumentSettings>

Congree UCC v7 EN