Интерфейс Antiplagiat.ApiCorp.IApiCorp

Контракт для работы с API системы Antiplagiat. Подробнее...

Открытые члены
UploadResult	UploadDocument (DocData data, DocAttributes attributes=null, UploadOptions options=null)
	Загрузка документа. Может быть загружен как отдельный документ, так и архив документов. Список поддерживаемых типов см. DocData.FileType. При загрузке архива документы не поддерживаемых типов внутри архива игнорируются.
DocAttributes	UpdateDocumentAttributes (DocumentId docId, DocAttributes attributes)
	Обновить атрибуты документа. Изменяются только заданные атрибуты. Чтобы удалить пользовательский атрибут, в его значении нужно указать null, пустую строку или строку из пробелов. Не доступно редактирование атрибутов: SourceFileName, UserEmail, DetectedLanguages, CheckLanguages, UserName.
DocumentId	SetExternalId (DocumentId docId, string externalId)
	Задать документу уникальный внешний идентификатор. В результате работы функции изменяется только внешний идентификатор, внутренний идентификатор не изменяется.
DocInfo	GetDocumentInfo (DocumentId docId, InfoOptions options=null)
	Получить информацию о документе. В параметре options указывается, какая информация интересует.
DocInfo[]	GetDocumentsInfo (DocumentId[] docIds, InfoOptions options=null)
	Получить информацию о списке документов. В параметре options указывается какая информация интересует.
string	GetDocumentText (DocumentId docId)
	Получить текст документа.
void	CheckDocument (DocumentId docId, string[] checkServicesList, CheckDocParams checkDocParameters=null)
	Запустить проверку документа.
CheckStatus	GetCheckStatus (DocumentId docId)
	Получить статус последней проверки документа.
CheckStatus[]	GetCheckStatuses (DocumentId[] docIds)
	Получить статус последней проверки для документов из указанного списка.
ReportSummary[]	GetReportHistory (DocumentId docId)
	Получить историю отчетов по документу.
ReportView	GetReportView (DocumentId docId, ReportViewOptions options=null)
	Получить отчет о проверке.
ReportDetails	GetSourceView (DocumentId docId, int reportNum, long srcHash, SourceViewOptions options=null)
	Получить информацию об источнике в отчете.
void	SetIndexedStatus (DocumentId docId, bool addToIndex)
	Обратите внимание на более общий метод SetIndexState(DocumentId, IndexState). Добавить документ в индекс совпадений или удалить документ из индекса. После удаления из индекса документ перестает находиться как источник совпадения (одобренного цитирования) в проверках. При удалении документа из индекса, отчеты, сделанные до удаления, останутся без изменений.
void	DeleteDocument (DocumentId docId)
	Удалить ранее загруженный документ. Если у документа был задан внешний идентификатор, то после удаления этот внешний идентификатор освобождается (может быть использован для идентификации другого документа). При удалении документа удаляются также отчеты проверок по этому документу. При удалении документа происходит автоматическое его удаление из индекса. При удалении документа отчеты, сделанные до удаления, в которых документ фигурирует как источник, остаются без изменения.
DocumentId[]	EnumerateDocuments (DocumentId afterDocId, EnumerateDocumentsOptions options=null)
	Обратите внимание также на метод EnumerateReportInfos(EnumerateReportsOptions), который позволяет сразу получить информацию о результатах проверки. Перечислить идентификаторы документов. Идентификаторы перечисляются пачками - в options можно указать размер пачки. Чтобы получить следующую пачку, нужно указать идентификатор последнего документа в полученной пачке.
CompanyStats	GetCompanyStats ()
	УСТАРЕЛО! (Не поддерживается с 01.01.2024). Получить статистику по загруженным документам.
CheckServiceInfo[]	GetCheckServices ()
	Получить список проверяющих сервисов.
FolderTree	GetFolders (string email)
	Получить дерево папок.
int	AddFolder (string email, string name, FolderOptions options=null)
	Добавить папку. Внимание, метод можно использовать только в один поток.
void	DeleteFolder (string email, int folderId)
	Удалить папку.
void	RenameFolder (string email, int folderId, string name)
	Переименовать папку.
void	MoveFolder (string email, int folderId, int parentId)
	Переместить папку.
void	MoveDocuments (string email, int folderId, DocumentId[] docIds)
	Переместить документы в другую папку.
TariffInfo	GetTariffInfo ()
	Возвращает информацию о текущем тарифе.
ExportReportInfo	ExportReportToPdf (DocumentId docId, ExportReportOptions options=null)
	Экспортировать отчёт в PDF.
byte[]	GetVerificationReport (DocumentId docId, VerificationReportOptions options=null, FormattingOptions formattingOptions=null)
	Выгрузить справку в PDF.
ReportInfo[]	EnumerateReportInfos (EnumerateReportsOptions options)
	Метод возвращает список статусов проверки документов отфильтрованных по options .
IndexState	SetIndexState (DocumentId docId, IndexState indexState)
	Установить тип индексирования документа: добавить в индекс заимствований, добавить в индекс одобренных документов или удалить документ из индекса. При установке значения IndexState.None документ перестает находиться как источник заимствования (одобренный для цитирования) в проверках. При исключении документа из индекса, ранее сделанные отчеты с участием этого документа в качестве источника, остаются без изменения.
ExtractTextStatus	GetTextExtractStatus (DocumentId docId)
	Получить статус извлечения текста документа.
ExtractTextStatus[]	GetTextExtractStatuses (DocumentId[] docIds)
	Получить статус извлечения текстов документов.
BibliographyText	GetBibliographyText (DocumentId docId)
	Извлечь размеченный текст библиографии.
IndexState	GetIndexState (DocumentId docId)
	Получить текущий статус документа в индексе.
TimeSpan?	Ping ()
	Проверить доступность сервиса.

Подробное описание

Контракт для работы с API системы Antiplagiat.

Методы

AddFolder()

int Antiplagiat.ApiCorp.IApiCorp.AddFolder	(	string	email,
		string	name,
		FolderOptions	options = null
	)

Добавить папку. Внимание, метод можно использовать только в один поток.

Аргументы

email	Электронная почта пользователя. Пустая строка - хранилище.
name	Название папки.
options	Опции добавления.

Возвращает

Идентификатор созданной папки.

Исключения

UserNotFoundException	Не обнаружен пользователь с указанной электронной почтой email .
InvalidArgumentException	Задано недопустимое значение options.ParentId . Папки с указанным идентификатором не существует. Задано недопустимое значение name . Наименование папки не может быть пустой строкой или null.
ApiCorpException	Внутренняя ошибка сервиса.

CheckDocument()

void Antiplagiat.ApiCorp.IApiCorp.CheckDocument	(	DocumentId	docId,
		string[]	checkServicesList,
		CheckDocParams	checkDocParameters = null
	)

Запустить проверку документа.

Аргументы

docId	Идентификатор документа.
checkServicesList	Список кодов проверяющих сервисов, по которым требуется осуществить проверку. Может быть null - в этом случае поиск происходит по всем доступным для проверки коллекциям.
checkDocParameters	Параметры настройки поиска совпадений.

Исключения

DocumentIdException	Неверный идентификатор документа.
InvalidArgumentException	Не задан аргумент docId . В списке кодов проверяющих сервисов checkServicesList присутствует неизвестный код сервиса.
PermissionException	Данная проверка не может быть запущена из-за ограничений действующего тарифа
ImmediateException	В данный момент не может быть запущена проверка по указанному документу
ApiCorpException	Внутренняя ошибка сервиса.

DeleteDocument()

void Antiplagiat.ApiCorp.IApiCorp.DeleteDocument

(

DocumentId

docId

)

Удалить ранее загруженный документ. Если у документа был задан внешний идентификатор, то после удаления этот внешний идентификатор освобождается (может быть использован для идентификации другого документа). При удалении документа удаляются также отчеты проверок по этому документу. При удалении документа происходит автоматическое его удаление из индекса. При удалении документа отчеты, сделанные до удаления, в которых документ фигурирует как источник, остаются без изменения.

Аргументы

docId

Идентификатор документа.

Исключения

DocumentIdException	Неверный идентификатор документа.
InvalidArgumentException	Не задан аргумент docId
ImmediateException	Операция не может быть выполнена в данный момент. Например, по данному документу не завершена текущая проверка.
ApiCorpException	Внутренняя ошибка сервиса.

DeleteFolder()

void Antiplagiat.ApiCorp.IApiCorp.DeleteFolder	(	string	email,
		int	folderId
	)

Удалить папку.

Аргументы

email	Электронная почта пользователя. Пустая строка - хранилище.
folderId	Идентификатор папки.

Исключения

UserNotFoundException	Не обнаружен пользователь с указанной электронной почтой email .
InvalidArgumentException	Задано недопустимое значение folderId . Папки с указанным идентификатором не существует.
ApiCorpException	Внутренняя ошибка сервиса.

EnumerateDocuments()

DocumentId[] Antiplagiat.ApiCorp.IApiCorp.EnumerateDocuments	(	DocumentId	afterDocId,
		EnumerateDocumentsOptions	options = null
	)

Обратите внимание также на метод EnumerateReportInfos(EnumerateReportsOptions), который позволяет сразу получить информацию о результатах проверки. Перечислить идентификаторы документов. Идентификаторы перечисляются пачками - в options можно указать размер пачки. Чтобы получить следующую пачку, нужно указать идентификатор последнего документа в полученной пачке.

Аргументы

afterDocId	Идентификатор последнего документа из предыдущей пачки. Может быть null - в этом случае перечисление начинается с начала списка загруженных документов.
options	Опции перечисления.

Возвращает

Идентификаторы документов, добавленные после документа afterDocId. Документы перечисляются в порядке их добавления в сервис. Пустой список означает, что документов добавленных после afterDocId нет.

Исключения

DocumentIdException	Неверный идентификатор документа
InvalidArgumentException	Не задан аргумент afterDocId . Задана недопустимая связка значений options.FromUser и options.InStorage . InStorage должен быть равен true, если options.FromUser равен null. Задана недопустимая связка значений options.FolderId и options.InStorage . InStorage не может быть равен null, если options.FolderId не равен null. Задана недопустимая связка значений options.FolderId , options.InStorage и options.FromUser . options.InStorage не может быть равен false, а options.FromUser равен null, если options.FolderId не равен null.
UserNotFoundException	Не обнаружен пользователь с указанной электронной почтой options.FromUser .
ApiCorpException	Внутренняя ошибка сервиса.

EnumerateReportInfos()

ReportInfo[] Antiplagiat.ApiCorp.IApiCorp.EnumerateReportInfos

(

EnumerateReportsOptions

options

)

Метод возвращает список статусов проверки документов отфильтрованных по options .

Аргументы

options

Параметры фильтрации результатов проверки.

Возвращает

Массив описаний отчетов по заданным опциям фильтрации.

ExportReportToPdf()

ExportReportInfo Antiplagiat.ApiCorp.IApiCorp.ExportReportToPdf	(	DocumentId	docId,
		ExportReportOptions	options = null
	)

Экспортировать отчёт в PDF.

Аргументы

docId	Идентификатор документа.
options	Опции экспорта отчёта.

Возвращает

Информация об экспорте отчёта.

Исключения

DocumentIdException	Неверный идентификатор документа.
InvalidArgumentException	Не задан аргумент docId . В options указан недопустимый номер отчёта.
PermissionException	Зарезервировано для будущих тарифов.
ApiCorpException	Внутренняя ошибка сервиса.

GetBibliographyText()

BibliographyText Antiplagiat.ApiCorp.IApiCorp.GetBibliographyText

(

DocumentId

docId

)

Извлечь размеченный текст библиографии.

Аргументы

docId

Идентификатор документа.

Исключения

DocumentIdException	Неверный идентификатор документа.
InvalidArgumentException	Не задан аргумент docId .
ApiCorpException	Внутренняя ошибка сервиса.
ImmediateException	Метод не может быть вызван в данный момент (извлечение текста еще не завершено, либо метод слишком часто вызывается для одного документа).
PermissionException	У компании нет доступа к указанному методу.

GetCheckServices()

CheckServiceInfo[] Antiplagiat.ApiCorp.IApiCorp.GetCheckServices

(

)

Получить список проверяющих сервисов.

Возвращает

Список проверяющих сервисов, по которым возможно осуществлять проверки.

Исключения

ApiCorpException

Внутренняя ошибка сервиса.

GetCheckStatus()

CheckStatus Antiplagiat.ApiCorp.IApiCorp.GetCheckStatus

(

DocumentId

docId

)

Получить статус последней проверки документа.

Аргументы

docId

Идентификатор документа.

Возвращает

Текущий статус проверки указанного документа.

Исключения

DocumentIdException	Не верный идентификатор документа.
InvalidArgumentException	Не задан аргумент docId .
ApiCorpException	Внутренняя ошибка сервиса.

GetCheckStatuses()

CheckStatus[] Antiplagiat.ApiCorp.IApiCorp.GetCheckStatuses

(

DocumentId[]

docIds

)

Получить статус последней проверки для документов из указанного списка.

Аргументы

docIds

Список документов для получения статуса последней проверки.

Возвращает

Список статусов последней проверки указанного списка документов.

Исключения

DocumentIdException	В списке docIds содержится неверный идентификатор документа.
InvalidArgumentException	Не задан аргумент docIds . Список docIds не содержит ни одного элемента.
ApiCorpException	Внутренняя ошибка сервиса.

GetCompanyStats()

CompanyStats Antiplagiat.ApiCorp.IApiCorp.GetCompanyStats

(

)

УСТАРЕЛО! (Не поддерживается с 01.01.2024). Получить статистику по загруженным документам.

Возвращает

Статистика по загруженным документам.

Исключения

ApiCorpException

Внутренняя ошибка сервиса.

GetDocumentInfo()

DocInfo Antiplagiat.ApiCorp.IApiCorp.GetDocumentInfo	(	DocumentId	docId,
		InfoOptions	options = null
	)

Получить информацию о документе. В параметре options указывается, какая информация интересует.

Аргументы

docId	Идентификатор документа.
options	Состав требуемой информации о документе.

Возвращает

Информация о документе.

Исключения

DocumentIdException	Неверный идентификатор документа.
InvalidArgumentException	Не задан аргумент docId .
ApiCorpException	Внутренняя ошибка сервиса.

GetDocumentsInfo()

DocInfo[] Antiplagiat.ApiCorp.IApiCorp.GetDocumentsInfo	(	DocumentId[]	docIds,
		InfoOptions	options = null
	)

Получить информацию о списке документов. В параметре options указывается какая информация интересует.

Аргументы

docIds	Список идентификаторов документов.
options	Состав требуемой информации о документе.

Возвращает

Информация о документах.

Исключения

DocumentIdException	В списке docIds содержится неверный идентификатор документа.
InvalidArgumentException	Не задан аргумент docIds . Список docIds не содержит ни одного элемента.
ApiCorpException	Внутренняя ошибка сервиса.

GetDocumentText()

string Antiplagiat.ApiCorp.IApiCorp.GetDocumentText

(

DocumentId

docId

)

Получить текст документа.

Аргументы

docId

Идентификатор документа.

Возвращает

Текст документа.

Исключения

DocumentIdException	Неверный идентификатор документа.
InvalidArgumentException	Не задан аргумент docId .
ApiCorpException	Внутренняя ошибка сервиса.

GetFolders()

FolderTree Antiplagiat.ApiCorp.IApiCorp.GetFolders

(

string

email

)

Получить дерево папок.

Аргументы

email

Электронная почта пользователя. Пустая строка - хранилище.

Возвращает

Дерево папок пользователя/хранилища.

Исключения

UserNotFoundException	Не обнаружен пользователь с указанной электронной почтой email .
ApiCorpException	Внутренняя ошибка сервиса.

GetIndexState()

IndexState Antiplagiat.ApiCorp.IApiCorp.GetIndexState

(

DocumentId

docId

)

Получить текущий статус документа в индексе.

Аргументы

docId

Идентификатор документа.

Возвращает

Текущий статус документа в индексе.

Исключения

DocumentIdException	Неверный идентификатор документа.
InvalidArgumentException	Не задан аргумент docId .
PermissionException	Нет прав на получение информации о данном документе.
ApiCorpException	Внутренняя ошибка сервиса.

GetReportHistory()

ReportSummary[] Antiplagiat.ApiCorp.IApiCorp.GetReportHistory

(

DocumentId

docId

)

Получить историю отчетов по документу.

Аргументы

docId

Идентификатор документа.

Возвращает

История отчетов. Список аннотаций завершенных отчетов.

Исключения

DocumentIdException	Неверный идентификатор документа.
InvalidArgumentException	Не задан аргумент docId .
ApiCorpException	Внутренняя ошибка сервиса.

GetReportView()

ReportView Antiplagiat.ApiCorp.IApiCorp.GetReportView	(	DocumentId	docId,
		ReportViewOptions	options = null
	)

Получить отчет о проверке.

Аргументы

docId	Идентификатор документа.
options	Опции отчета.

Возвращает

Представление отчета о проверке.

Исключения

DocumentIdException	Неверный идентификатор документа.
InvalidArgumentException	Не задан аргумент docId . В options указан недопустимый номер отчета.
PermissionException	Зарезервировано для будущих тарифов.
ApiCorpException	Внутренняя ошибка сервиса.

GetSourceView()

ReportDetails Antiplagiat.ApiCorp.IApiCorp.GetSourceView	(	DocumentId	docId,
		int	reportNum,
		long	srcHash,
		SourceViewOptions	options = null
	)

Получить информацию об источнике в отчете.

Аргументы

docId	Идентификатор документа.
reportNum	Номер отчета.
srcHash	Идентификатор источника в отчете.
options	Опции отчета по источнику.

Возвращает

Положение блоков цитирования внутри текста источника.

Исключения

DocumentIdException	Неверный идентификатор документа.
InvalidArgumentException	Не задан аргумент docId . Задано недопустимое значение reportNum . Задано недопустимое значение srcHash . Идентификатор источника в отчете следует брать из SourceInfo.SrcHash
PermissionException	Зарезервировано для будущих тарифов.
ApiCorpException	Внутренняя ошибка сервиса.

GetTariffInfo()

TariffInfo Antiplagiat.ApiCorp.IApiCorp.GetTariffInfo

(

)

Возвращает информацию о текущем тарифе.

Возвращает

Информация о текущем тарифе.

Исключения

ApiCorpException

Внутренняя ошибка сервиса.

GetTextExtractStatus()

ExtractTextStatus Antiplagiat.ApiCorp.IApiCorp.GetTextExtractStatus

(

DocumentId

docId

)

Получить статус извлечения текста документа.

Аргументы

docId

Идентификатор документа.

Исключения

DocumentIdException	Неверный идентификатор документа.
InvalidArgumentException	Не задан аргумент docId .
ApiCorpException	Внутренняя ошибка сервиса.

GetTextExtractStatuses()

ExtractTextStatus[] Antiplagiat.ApiCorp.IApiCorp.GetTextExtractStatuses

(

DocumentId[]

docIds

)

Получить статус извлечения текстов документов.

Аргументы

docIds

Список документов для получения статуса извлечения текста.

Возвращает

Список статусов извлечения текста.

Исключения

DocumentIdException	В списке docIds содержится неверный идентификатор документа
InvalidArgumentException	Не задан аргумент docIds . Список docIds не содержит ни одного элемента.
ApiCorpException	Внутренняя ошибка сервиса.

GetVerificationReport()

byte[] Antiplagiat.ApiCorp.IApiCorp.GetVerificationReport	(	DocumentId	docId,
		VerificationReportOptions	options = null,
		FormattingOptions	formattingOptions = null
	)

Выгрузить справку в PDF.

Аргументы

docId	Идентификатор документа.
options	Опции выгрузки справки.
formattingOptions	Кастомные опции для выгруженного документа.

Возвращает

Справка в формате pdf.

Исключения

DocumentIdException	Неверный идентификатор документа.
InvalidArgumentException	Не задан аргумент docId .
PermissionException	Зарезервировано для будущих тарифов.
ApiCorpException	Внутренняя ошибка сервиса.

MoveDocuments()

void Antiplagiat.ApiCorp.IApiCorp.MoveDocuments	(	string	email,
		int	folderId,
		DocumentId[]	docIds
	)

Переместить документы в другую папку.

Аргументы

email	Электронная почта пользователя. Пустая строка - хранилище.
folderId	Идентификатор папки, в которую нужно переместить документы.
docIds	Идентификаторы документов, которые нужно переместить.

Исключения

UserNotFoundException	Не обнаружен пользователь с указанной электронной почтой email .
DocumentIdException	Неверный идентификатор документа.
InvalidArgumentException	Не задан аргумент docIds . Список docIds не содержит ни одного элемента. Список docIds содержит идентификаторы несуществующих документов. Список docIds содержит идентификаторы документов, которые не принадлежат пользователю.
ApiCorpException	Внутренняя ошибка сервиса.

MoveFolder()

void Antiplagiat.ApiCorp.IApiCorp.MoveFolder	(	string	email,
		int	folderId,
		int	parentId
	)

Переместить папку.

Аргументы

email	Электронная почта пользователя. Пустая строка - хранилище.
folderId	Идентификатор изменяемой папки.
parentId	Идентификатор родительской папки (внутри которой будет находиться редактируемая папка).

Исключения

UserNotFoundException	Не обнаружен пользователь с указанной электронной почтой email .
InvalidArgumentException	Задано недопустимое значение folderId . Папки с указанным идентификатором не существует. Задано недопустимое значение parentId . Папки с указанным идентификатором не существует. Задано недопустимое значение parentId . Папка с указанным идентификатором является вложенной для изменяемой.
ApiCorpException	Внутренняя ошибка сервиса.

Ping()

TimeSpan? Antiplagiat.ApiCorp.IApiCorp.Ping

(

)

Проверить доступность сервиса.

Возвращает

Время реакции сервиса. Осмысленное значение имеет только при использовании нативного клиента.

Исключения

ApiCorpException

Внутренняя ошибка сервиса.

RenameFolder()

void Antiplagiat.ApiCorp.IApiCorp.RenameFolder	(	string	email,
		int	folderId,
		string	name
	)

Переименовать папку.

Аргументы

email	Электронная почта пользователя. Пустая строка - хранилище.
folderId	Идентификатор папки.
name	Новое название папки.

Исключения

UserNotFoundException	Не обнаружен пользователь с указанной электронной почтой email .
InvalidArgumentException	Задано недопустимое значение folderId . Папки с указанным идентификатором не существует. Задано недопустимое значение name . Наименование папки не может быть пустой строкой или null.
ApiCorpException	Внутренняя ошибка сервиса.

SetExternalId()

DocumentId Antiplagiat.ApiCorp.IApiCorp.SetExternalId	(	DocumentId	docId,
		string	externalId
	)

Задать документу уникальный внешний идентификатор. В результате работы функции изменяется только внешний идентификатор, внутренний идентификатор не изменяется.

Аргументы

docId	Идентификатор документа.
externalId	Внешний идентификатор документа, который нужно установить. Если задано значение null или "", то внешний идентификатор будет удален.

Возвращает

Обновленный идентификатор документа.

Исключения

DocumentIdException	Не верный идентификатор документа.
InvalidArgumentException	Не задан аргумент docId . Среди загруженных документов уже есть документ с указанным внешним идентификатором
ApiCorpException	Внутренняя ошибка сервиса.

SetIndexedStatus()

void Antiplagiat.ApiCorp.IApiCorp.SetIndexedStatus	(	DocumentId	docId,
		bool	addToIndex
	)

Обратите внимание на более общий метод SetIndexState(DocumentId, IndexState). Добавить документ в индекс совпадений или удалить документ из индекса. После удаления из индекса документ перестает находиться как источник совпадения (одобренного цитирования) в проверках. При удалении документа из индекса, отчеты, сделанные до удаления, останутся без изменений.

Аргументы

docId	Идентификатор документа.
addToIndex	Действие с документом: true - добавить документ в индекс совпадений; false - удалить документ из индекса.

Исключения

DocumentIdException	Неверный идентификатор документа.
InvalidArgumentException	Не задан аргумент docId .
PermissionException	Добавление документов в индекс не предусмотрено действующим тарифом.
ApiCorpException	Внутренняя ошибка сервиса.

SetIndexState()

IndexState Antiplagiat.ApiCorp.IApiCorp.SetIndexState	(	DocumentId	docId,
		IndexState	indexState
	)

Установить тип индексирования документа: добавить в индекс заимствований, добавить в индекс одобренных документов или удалить документ из индекса. При установке значения IndexState.None документ перестает находиться как источник заимствования (одобренный для цитирования) в проверках. При исключении документа из индекса, ранее сделанные отчеты с участием этого документа в качестве источника, остаются без изменения.

Аргументы

docId	Идентификатор документа.
indexState	Тип индексирования.

Возвращает

Результат выполнения команды. Внимание! Документ может оказаться в состоянии отличном от передаваемом в параметрах, например в IndexState.InProgress или даже в исходном состоянии.

Исключения

DocumentIdException	Неверный идентификатор документа.
InvalidArgumentException	Не задан аргумент docId . Или indexState = IndexState.InProgress.
PermissionException	Добавление документов в индекс не предусмотрено действующим тарифом.
ApiCorpException	Внутренняя ошибка сервиса.

UpdateDocumentAttributes()

DocAttributes Antiplagiat.ApiCorp.IApiCorp.UpdateDocumentAttributes	(	DocumentId	docId,
		DocAttributes	attributes
	)

Обновить атрибуты документа. Изменяются только заданные атрибуты. Чтобы удалить пользовательский атрибут, в его значении нужно указать null, пустую строку или строку из пробелов. Не доступно редактирование атрибутов: SourceFileName, UserEmail, DetectedLanguages, CheckLanguages, UserName.

Аргументы

docId	Идентификатор документа.
attributes	Полные атрибуты документа после обновления.

Возвращает

Обновленные атрибуты документа.

Исключения

DocumentIdException	Неверный идентификатор документа.
InvalidArgumentException	Не задан аргумент docId . Не задан аргумент attributes . Значение одного из атрибутов документа превышает допустимую длину. Cм. DocAttributes. Имя одного из атрибутов превышает допустимую длину. Cм. DocAttributes. Исключения ApiCorpException Внутренняя ошибка сервиса.

UploadDocument()

UploadResult Antiplagiat.ApiCorp.IApiCorp.UploadDocument	(	DocData	data,
		DocAttributes	attributes = null,
		UploadOptions	options = null
	)

Загрузка документа. Может быть загружен как отдельный документ, так и архив документов. Список поддерживаемых типов см. DocData.FileType. При загрузке архива документы не поддерживаемых типов внутри архива игнорируются.

Аргументы

data	Описание загружаемого файла.
attributes	Атрибуты загружаемого документа. Заполнение данного поля влияет на отображение документа в результатах поиска (если он будет добавлен в индекс), и заполнение различный полей в отчетах, справках и т.п. В случае, если загружается архив с несколькими документами, указанные атрибуты приписываются каждому из документов в архиве. Имя файла будет сформировано как "имя архива"\"имя файла в архиве".
options	Необязательные опции.

Возвращает

Результат загрузки. Включает в себя список идентификаторов документов. При загрузке архива, в случае, если ни из одного файла, содержащегося в архиве, не удалось извлечь текст, результат будет содержать пустой список загруженных документов. К сожалению, в текущей версии для проблемных файлов внутри архива нет возможности выдавать диагностику, по какой причине из файла не был извлечен текст.

Исключения

InvalidArgumentException	Не задан аргумент data . У аргумента data не задано одно из обязательных полей: DocData.FileType, DocData.Data, DocData.ExternalUserID. У аргумента data для поля DocData.FileType задано недопустимое или неверное значение. У аргумента data для поля DocData.Encoding задано недопустимое значение. У аргумента data в поле DocData.Languages присутствует недопустимое значение. У аргумента data в поле DocData.ExternalUserID присутствует недопустимое значение. У аргумента options в поле UploadOptions.IndexState передано значение IndexState.InProgress. Значение одного из атрибутов документа превышает допустимую длину. Cм. DocAttributes. Имя одного из атрибутов превышает допустимую длину. Cм. DocAttributes. Количество допустимых атрибутов документа превышает допустимое. Cм. DocAttributes.
UserNotFoundException	У аргумента options для поля UploadOptions.FromUser задано недопустимое или неверное значение.
PermissionException	Пользователь заблокирован из-за подозрительных действий.
OperationDenialException	Пользователь нарушил положения "Манифеста честного пользователя". Операция добавления документа недоступна.
ApiCorpException	Внутренняя ошибка сервиса.
InvalidArgumentException	У аргумента options в поле UploadOptions.IndexState передано значение IndexState.InProgress.