Document settings

GET

/congree/api/Settings/v1/Document

Gets list of available document-specific rule sets

Response

[
"string"
]

Response example Quelle erweitern

GET

/congree/api/Settings/v1/Document/{RulesetName}

Gets all document-specific rule set settings

{RulesetName} is the name of the document-specific rule set. Available settings groups are described here.
Response

{
<Settings group name>: <Settings object>
}

GET

/congree/api/Settings/v1/Document/{RulesetName}/{SettingsGroupName}

Gets specified document-specific rule set settings

{SettingsGroupName} is the name of the settings group. Parameter can contain a set of comma separated groups. Available settings groups are described here.
Response

{
<Settings group name>: <Settings object>
}

Available document-specific rule set settings groups

Language settings

Group name: LanguageSettings

Structure:
Language settings

{
"Language": string
}

Language Check Report configuration

Group name: LinguisticReportingConfiguration

Structure (corresponds to LinguisticReportConfiguration, see Congree Bulk Check Service documentation, Type definitions - IBulkCheckSettingsService - Document settings XML description):
Linguistic reporting settings

{
  "ConfigurationName": string,
  "Language": string,
  "WordCountFactor": double,
  "HighRatingLimit": double,
  "HighRatingName": string,
  "MediumRatingLimit": double,
  "MediumRatingName": string,
  "LowRatingLimit": double,
  "LowRatingName": string,
  "Rules": [
    {
      "RuleName": string,
      "CategoryType": string,
      "Weight": double
    }
  ],
  "Categories": [
    {
      "ErrorType": string,
      "Priority": double
    }
  ]
}

Linguistic reporting settings example Quelle erweitern

Paragraph recognition settings

Group name: ParagraphRecognition
Response structure

"ParagraphRecognition": {
    "IsAutomaticMode": bool,
    "SymbolsAmountToCheck": int,
    "CheckUnitDefinitions": [
        {
            "Name": string,
            "Treatment": string,
            "StructureClass": string,
            "Parents": string,
            "Attributes": string,
            "Rules": [
                {
                    "ErrorType": string,
                    "ErrorCode": string,
                    "IsDeactivated": bool
                }
            ]
        }
    ],
    "InlineElementDefinitions": [
        {
            "Name": string,
            "Treatment": string,
            "IsReadOnly": bool,
            "LanguageCheckSpecifics": string,
            "Parents": string,
            "Attributes": string
        }
    ]
}

Sample response Quelle erweitern