ntiplagiat.ApiCorp.Model Namespace

Classes
class	AuthorName
class	BibliographyText
	Marked up text of the bibliography More details...
class	CheckDocParams
	Document check parameters. More details...
class	CheckServiceInfo
	Information about the checking service. More details...
class	CheckServiceResultInfo
	Report for an individual search module. More details...
class	CheckStatus
	Current status of the check. More details...
class	CiteBlock
	Block of similarity. More details...
class	CompanyStats
	Statistics on loaded documents. More details...
class	CustomAttribute
	Additional document attribute. More details...
class	DocAttributes
	Document attributes More details...
class	DocData
	Uploaded data More details...
class	DocInfo
	Information about the document More details...
class	DocStat
	Statistics on the document text. More details...
class	DocumentId
	In all cases when DocId is returned by some function system always fills the Id field. The External field is filled in case if it set for the corresponding document. If the DocId is passed to any function, it is enough to fill in one of the fields. The situation when both fields are filled in, but they correspond to different documents, leads to an exception. More details...
class	EnumerateDocumentsOptions
	Options of documents enumeration function More details...
class	EnumerateReportsOptions
	Options for the function of listing the check results. Sorting is always reverse chronological, the last uploaded documents are passed first. More details...
class	ExcludeParams
	Conditions for excluding sites. More details...
class	ExportReportInfo
	Information about exporting the report. More details...
class	ExportReportOptions
	Optional method options IApiCorp.ExportReportToPdf. More details...
class	ExtractTextStatus
	Current status of document text extraction. More details...
class	FileStatus
	Status of uploaded documents. More details...
class	FolderOptions
	Optional method options IApiCorp.AddFolder More details...
class	FolderTree
	The user's folder tree. More details...
class	FormattingOptions
	Contains custom report options. More details...
class	FraudUnit
	Information about cheating More details...
class	InfoOptions
	Optional options of methods GetDocumentInfo and GetDocumentsInfo. More details...
class	PersonIDs
	Person's IDs in different systems. More details...
class	ReportDetails
	Details of the citation blocks More details...
class	ReportInfo
	Optional options of methods GetDocumentInfo and GetDocumentsInfo. More details...
class	ReportSummary
	Annotation to the document check report More details...
class	ReportView
	Report data More details...
class	ReportViewOptions
	Optional method options IApiCorp.GetReportView More details...
class	Score
	The total amount of text covered by similarities, detailed information about the fields - https://docs.antiplagiat.ru/en/html/private_user_guide.html#vvedenie-terminy-i-opredelenija More details...
class	ShortFraudReport
	Data for the brief report about cheating (suspicious document) More details...
class	SourceInfo
	Information about found citation source. More details...
class	SourceViewOptions
	Options for getting sources. There are no options in the current version More details...
class	TariffInfo
	Information about the current tariff plan. More details...
class	UploadOptions
	Document upload options More details...
class	UploadResult
	Result of uploading the document. More details...
class	VerificationReportOptions
	Optional method options IApiCorp.GetVerificationReport. More details...

Enumerations
enum	BibliographyStatus { BibliographyStatus.None = 0, BibliographyStatus.Ok = 1, BibliographyStatus.NotExtracted = 2 }
	Bibliography extraction status. More details...
enum	ReportStatus { ReportStatus.None = 0, ReportStatus.InProgress = 1, ReportStatus.Ready = 2, ReportStatus.Failed = 3 }
	Check status More details...
enum	ExportReportStatus { ExportReportStatus.Failed = 0, ExportReportStatus.InProgress = 1, ExportReportStatus.Ready = 2 }
	Status of report export. More details...
enum	TextStatus { TextStatus.InProgress = 0, TextStatus.Ready = 1, TextStatus.Failed = 2 }
	Text extraction status. More details...
enum	FraudType {   FraudType.UnprintableCharacter = 1, FraudType.DiacriticCharacter = 2, FraudType.SmallLinearSize = 3, FraudType.SplitToken = 4,   FraudType.Truncate = 5, FraudType.SmallFontSize = 6, FraudType.TokenGeometryInvalid = 7, FraudType.Invisibility = 8,   FraudType.Symbols = 9, FraudType.Equation = 10, FraudType.TinyScale = 11, FraudType.NegativeSpacing = 15,   FraudType.Homoglyph = 16 }
	IDs of cheating More details...
enum	IndexState { IndexState.None = 0, IndexState.Indexed = 1, IndexState.Approved = 2 }
	Type of indexing. More details...
enum	FailReason {   FailReason.NoError = 0, FailReason.NoText = 1, FailReason.UnsupportedFormat = 2, FailReason.ServerInternalError = 3,   FailReason.UploadTimeOut = 4, FailReason.WrongFormat = 5, FailReason.TooMuchSymbols = 6 }
	The reason why the document wasn't uploaded. More details...

Enumerations

BibliographyStatus

enum Antiplagiat.ApiCorp.Model.BibliographyStatus

strong

Bibliography extraction status.

Elements of enumeration
None	A fragment of the bibliography was not found (possibly missing) in the text.
Ok	Bibliographic records have been successfully extracted.
NotExtracted	A bibliographic fragment was found, but it was not possible to divide it into elements.

ExportReportStatus

enum Antiplagiat.ApiCorp.Model.ExportReportStatus

strong

Status of report export.

Elements of enumeration
Failed	Report export ended up with an error.
InProgress	Report export is in process.
Ready	Report is exported.

FailReason

enum Antiplagiat.ApiCorp.Model.FailReason

strong

The reason why the document wasn't uploaded.

Elements of enumeration
NoError	The document was uploaded successfully.
NoText	Document text extraction failed.
UnsupportedFormat	Unsupported document format. Value DocData.FileType has an incorrect format or the passed file format is not supported by the system.
ServerInternalError	An internal service error occurred while processing the document.
UploadTimeOut	Document downloads could not be completed till time out.
WrongFormat	Value DocData.FileType does not correspond to the actual content of the document. Possibly it's an attempt of cheating.
TooMuchSymbols	The number of characters of the uploaded document exceeds the maximum allowed limit.

FraudType

enum Antiplagiat.ApiCorp.Model.FraudType

strong

IDs of cheating

Elements of enumeration
UnprintableCharacter	Unprintable symbol.
DiacriticCharacter	Diacritic symbol
SmallLinearSize	Small linear dimensions.
SplitToken	Merge after this symbol.
Truncate	Cutting off excess tokens.
SmallFontSize	Small font size.
TokenGeometryInvalid	Signals that the token is invalid. The token is invalid if it has invalid formatting data (for example, the width or height of a rectangle is less than or equal to 0).
Invisibility	Invisibility.
Symbols	Symbols of the Symbol font (Greek letters, arithmetic operations, etc.).
Equation	Formula.
TinyScale	Tiny scale.
NegativeSpacing	Negative character-to-character distance.
Homoglyph	Omoglyph.

IndexState

enum Antiplagiat.ApiCorp.Model.IndexState

strong

Type of indexing.

Elements of enumeration
None	The document has not been added either to own collection or to approved documents.
Indexed	The document added to similarity index.
Approved	The document added to index of approved documents.

ReportStatus

enum Antiplagiat.ApiCorp.Model.ReportStatus

strong

Check status

Elements of enumeration
None	There were no checks of this document
InProgress	The last check is not completed yet.
Ready	The last check ended up successfully.
Failed	The last check failed.

TextStatus

enum Antiplagiat.ApiCorp.Model.TextStatus

strong

Status of document text extraction.

Elements of enumeration
InProgress	Text extraction is not completed yet.
Ready	Text is extracted.
Failed	The text could not be extracted from the document.