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