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:

Argument	Meaning
securityToken	Security token string
ruleSetName	Name of the rule set to get settings from
settingsGroup	Required 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.

Value	Meaning
None	Empty value. Nothing is returned.
LinguisticReportingConfiguration

Type definitions: IBulkCheckSettingsService

IBulkCheckSettingsService interface

GetDocumentSettings method

DocumentSettingsGroup enumeration

Related topics