Document

Name

Type

Description

Id

int

The ID of a document.

The only way to set an ID for a document is to use the GetBatchIdsRange method, which allows reserving IDs for new documents. We recommend that you set an ID for a document before you add the document to a batch.

A document ID will be generated automatically if you set its value to -1.

BatchId

int

The ID of the batch

ParentId

int

The ID of the parent document of the set.

If a new document should be part of a set, this field should be assigned the value of the parent document of the set.

If a new document should not be part of any set, set the value of the field to 0.

Important! The parent document must be created before child documents are created.

ChildrenOrder

ChildrenOrder []

A set of child documents enabling the sorting of documents in the set.

When data are read from the server, the field is filled out automatically.

If this field is empty, the documents in the set will be arranged in the order in which they were added.

DocIndex

int

Document index

TemplateName

string

The name of the Document Definition

ProcessingStageType

int

The type of the processing stage; values come from ProcessingStageType

Comment

string

Comment

Pages

Page[]

The set of pages in the document

IsProcessed

bool

A flag that shows whether the document has been processed or not

HasProcessingErrors

bool

A flag that shows whether there were processing errors

HasDocumentErrors

bool

A flag that shows whether there are errors in the document (e.g. format errors, rules errors, assembly errors)

ErrorText

string

A description of the document processing errors

ExternalId

string

The external ID of the document

Properties

RegistrationProperty[]

The set of registration parameters for the document

Priority

Priority[]

Document priority

FileVersion

int

The version of the document file on the server

OwnerId

int

The ID of the user or group who owns the project

StageExternalId

int

The ID of the processing stage in which the task was created (unique within the batch type)

TaskId

int

The ID of the task the document belongs to

UncertainSymbols

int

The number of uncertain characters

VerificationSymbols

int

The number of verified characters

TotalSymbols

int

The total number of characters in the document

HasErrors

bool

A flag that shows whether there are any validation rule errors

HasWarnings

bool

A flag that shows whether there are any validation rule warnings

HasAssemblingErrors

bool

A flag that shows whether there were assembling errors

HasAttachments

bool

A flag that shows whether the document has attachments

Flags

int

A set of flags that describe the status of the document. The value of a field is a combination of the values of the flags, which include:

• BIF_IsAnalyzed = 0x100 shows that the document is analysed;
• BIF_IsRecognized = 0x200 shows that the document is recognized;
• BIF_IsVerified = 0x400 shows that the document is verified;
• BIF_IsExported = 0x800 shows that the document is exported;
• BIF_HasRuleErrors = 0x10000 shows that the document contains rule execution errors;
• BIF_HasRuleWarnings = 0x20000 - shows that the document contains rule execution warnings;
• BIF_HasMergeVersionErrors = 0x80000 - shows that the document contains errors of merging double verification results (verification results do not match);;
• BIF_HasUserAttachments = 0x100000 - shows that the document has attachments;
• BIF_HasUnmatchedFieldErrors = 0x200000 - shows that the document contains unmatched fields;
• BIF_NeedsPreprocessing = 0x800000 - shows that the document needs preprocessing;
• BIF_IsManuallyCreated = 0x1000000 - shows that the document was created manually;
• BIF_IsExcludedFromAutomaticAssembling = 0x2000000 - shows that the document is excluded from automatic assembly;
• BIF_IsSourceImageAttached = 0x4000000 - shows that a source image file is attached to the document.

Note: Only those flags are listed which are useful when working with the tasks and methods of the Web Services API.