Type definitions: IBulkCheckSettingsService


IBulkCheckSettingsService interface

Interface definition
public interface IBulkCheckSettingsService
{
    string GetDocumentSettings(string securityToken, string ruleSetName, DocumentSettingsGroup settingsGroup);
}

GetDocumentSettings method

Method signature
string GetDocumentSettings(string securityToken, string ruleSetName, DocumentSettingsGroup settingsGroup);

Gets the specified document settings.

Arguments:

ArgumentMeaning
securityTokenSecurity token string
ruleSetNameName of the rule set to get settings from
settingsGroupRequired groups of settings

Returned value:

If successful, an XML containing specified setting groups is returned.

Faults:

  • CongreeBulkCheckFault
  • WrongCredentialsFault
  • SecurityTokenNotExistFault
  • SecurityTokenLockedFault

DocumentSettingsGroup enumeration

Enum definition
[Flags]
public enum DocumentSettingsGroup
{
    None = 0x00,
    LinguisticReportingConfiguration = 0x01
}

Represents required setting groups to acquire. Values can be concatenated using bitwise OR operator.

ValueMeaning
NoneEmpty value. Nothing is returned.
LinguisticReportingConfiguration

Related topics

For further information see: