ApiCorp: Интерфейс Antiplagiat.ApiCorp.IApiCorp
Документация ApiCorp  3.9.1
Интерфейс Antiplagiat.ApiCorp.IApiCorp

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

Открытые члены

UploadResult UploadDocument (DocData data, DocAttributes attributes=null, UploadOptions options=null)
 Загрузка документа. Может быть загружен как отдельный документ, так и архив документов. Список поддерживаемых типов см. DocData.FileType. При загрузке архива документы неподдерживаемых типов внутри архива игнорируются. Подробнее...
 
DocAttributes UpdateDocumentAttributes (DocumentId docId, DocAttributes attributes)
 Обновить атрибуты документа. Изменяются только заданные атрибуты. Чтобы удалить пользовательский атрибут, в его значении нужно указать null, пустую строку или строку из пробелов. Подробнее...
 
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 ()
 Получить статистику по загруженным документам. Подробнее...
 
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)
 Выгрузить справку в PDF. Подробнее...
 
ReportInfo [] EnumerateReportInfos (EnumerateReportsOptions options)
 Метод возвращает список статусов проверки документов отфильтрованых по options . Подробнее...
 
void SetIndexState (DocumentId docId, IndexState indexState)
 Установить тип индексирования документа: добавить в индекс заимстований, добавить в индекс одобренных документов или удалить документ из индекса. При установке значения IndexState.None документ перестает находиться как источник заимствования (одобренный для цитирования) в проверках. При изменении типа индексирования документа, ранее сделанные отчеты остаются без изменения. Подробнее...
 
ExtractTextStatus GetTextExtractStatus (DocumentId docId)
 Получить статус извлечения текста документа. Подробнее...
 
ExtractTextStatus [] GetTextExtractStatuses (DocumentId[] docIds)
 Получить статус извлечения текстов документов. Подробнее...
 
BibliographyText GetBibliographyText (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 ( )

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

Возвращает
Статистика по загруженным документам.
Исключения
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Внутренняя ошибка сервиса.

◆ 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 
)

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

Аргументы
docIdИдентификатор документа.
optionsОпции выгрузки справки.
Возвращает
Справка в формате 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()

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

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

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

◆ UpdateDocumentAttributes()

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

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

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