ApiCorp: Package List
Документация ApiCorp  0.12.0
 
Загрузка...
Поиск...
Не найдено
Package List
Полный список документированных пакетов.
[уровень детализации 1234]
 NAntiplagiat
 NApiCorp
 NExceptions
 CApiCorpExceptionБазовое исключение для всех исключений API для корпоративных клиентов. Возникает в случаях, когда невозможно конкретизировать проблему (непредвидимая ситуация на стороне сервера)
 CDocumentIdExceptionВ функцию был передан неверный идентификатор документа. Список возможных вариантов, при которых возникает это исключение:

  • Такой документ не существует (возможно удален).
  • Не задан ни внутренний ни внешний идентификатор.
  • Заданы оба идентификатора (и внутренний и внешний), но они относятся к разным документам.
 CImmediateExceptionПроизводимое действие не может быть выполнено немедленно
 CInvalidArgumentExceptionНедопустимое значение аргумента функции. Например, значение обязательного аргумента null
 COperationDenialExceptionЗапрос на операцию с документолм сделан с учетной записи, действия которой признаны подозрительными
 CPermissionExceptionПроизводимое действие не предусмотрено текущим тарифным планом
 CUserNotFoundExceptionВ функцию была передана неверная электронная почта. Список возможных вариантов при которых возникает это исключение:

  • Пользователя с такой электронной почтой не существует.
 NModel
 CAuthorName
 CBibliographyTextРазмеченный текст библиографии
 CCheckDocParamsПараметры проверки документов
 CCheckServiceInfoИнформация о проверяющем сервисе
 CCheckServiceResultInfoОтчет отдельного модуля поиска
 CCheckStatusТекущее состояние проверки
 CCiteBlockБлок совпадения
 CCompanyStatsСтатистика по загруженным документам
 CCustomAttributeДополнительный атрибут документа
 CDocAttributesАтрибуты документа
 CDocDataЗагружаемые данные
 CDocInfoИнформация о документе
 CDocStatСтатистика по тексту документа
 CDocumentIdВо всех случаях, когда DocId возвращает какая-либо функция, Система всегда заполняет поле Id, поле External заполняется при условии, что оно задано для соответствующего документа. Если DocId передается в какую-либо функцию, достаточно заполнить одно из полей. Ситуация, когда заполнены оба поля, но при этом они соответствуют разным документам, приводит к исключению
 CEnumerateDocumentsOptionsОпции функции перечисления документов
 CEnumerateReportsOptionsОпции функции перечисления результатов проверки. Сортировка всегда обратная хронологическая, последние загруженные документы выдаются первыми
 CExcludeParamsУсловия исключения сайтов
 CExportReportInfoИнформация об экспорте отчёта
 CExportReportOptionsНеобязательные опции метода IApiCorp.ExportReportToPdf
 CExtractTextStatusТекущее состояние извлечения текста документа
 CFileStatusСтатус загруженных документов
 CFolderOptionsНеобязательные опции метода IApiCorp.AddFolder
 CFolderTreeДерево папок пользователя
 CFormattingOptionsСодержит кастомные опции для отчета
 CFraudUnitИнформация по обходам
 CInfoOptionsНеобязательные опции методов GetDocumentInfo и GetDocumentsInfo
 CPersonIDsИдентификаторы персоны в различных системах
 CReportDetailsДетализация блоков цитирования
 CReportInfoНеобязательные опции методов GetDocumentInfo и GetDocumentsInfo
 CReportSummaryАннотация отчета о проверке документа
 CReportViewДанные отчета
 CReportViewOptionsНеобязательные опции метода IApiCorp.GetReportView
 CScoreСуммарный объем текста, покрытый совпадениями подробная информация по полям - https://docs.antiplagiat.ru/ru/html/private_user_guide.html#vvedenie-terminy-i-opredelenija
 CShortFraudReportДанные для краткого отчета по обходам
 CSourceInfoИнформация о найденном источнике цитирования
 CSourceViewOptionsОпции получения истоников. В текущей версии опции отсутствуют
 CStructureSectionsСекции структуры документа. По умолчанию все секции включены. Текст, для которого не удастся определить раздел, будет отнесён к основной части документа и проверен на оригинальность
 CTariffInfoИнформация о текущем тарифе
 CUploadOptionsОпции загрузки документа
 CUploadResultРезультат загрузки документа
 CVerificationReportOptionsНеобязательные опции метода IApiCorp.GetVerificationReport
 CIApiCorpКонтракт для работы с API системы Antiplagiat