Contract for working with the system API Antiplagiat. More details...
Public members | |
UploadResult | UploadDocument (DocData data, DocAttributes attributes=null, UploadOptions options=null) |
Upload of the document. Both a separate document and an archive of documents can be downloaded. For a list of supported types, see Doc Data.FileType. When downloading an archive, documents of unsupported types inside the archive are ignored. More details... | |
DocAttributes | UpdateDocumentAttributes (DocumentId docId, DocAttributes attributes) |
Update the document attributes. Only the specified attributes are changed. To remove a custom attribute, you must specify null, an empty string, or a string of spaces in its value. More details... | |
DocumentId | SetExternalId (DocumentId docId, String externalId) |
Set a unique external identifier for the document. As a result of the function, only the external identifier changes, the internal identifier does not change. More details... | |
DocInfo | GetDocumentInfo (DocumentId docId, InfoOptions options=null) |
Get information about the document. Parameter options indicates which information interests. More details... | |
DocInfo [] | GetDocumentsInfo (DocumentId[] docIds, InfoOptions options=null) |
Get information about the list of documents. Parameter options indicates which information interests. More details... | |
string | GetDocumentText (DocumentId docId) |
Get text of the document. More details... | |
void | CheckDocument (DocumentId docId, string[] checkServicesList, CheckDocParams checkDocParameters=null) |
Start document check. More details... | |
CheckStatus | GetCheckStatus (DocumentId docId) |
Get status of the last document check. More details... | |
CheckStatus [] | GetCheckStatuses (DocumentId[] docIds) |
Get status of the last check of documents from the specified list. More details... | |
ReportSummary [] | GetReportHistory (DocumentId docId) |
Get document report history. More details... | |
ReportView | GetReportView (DocumentId docId, ReportViewOptions options=null) |
Get check report More details... | |
ReportDetails | GetSourceView (DocumentId docId, int reportNum, long srcHash, SourceViewOptions options=null) |
Get information about the source in the report. More details... | |
void | SetIndexedStatus (DocumentId docId, bool addToIndex) |
Please pay attention to the more general method SetIndexState(DocumentId, IndexState). Add a document to the similarity index or remove a document from the index. After removal from the index, the document stops being a source of similarity (or approved citation) in the checks. When deleting a document from the index, reports made before deletion will remain unchanged. More details... | |
void | DeleteDocument (DocumentId docId) |
Delete a previously uploaded document. If an external identifier was set for a document, then after deletion this external identifier is released (it can be used to identify another document). When you delete a document, the audit reports for this document are also deleted. When a document is deleted, it is automatically deleted from the index. When deleting a document, the reports made before deletion, in which the document appears as a source, remain unchanged. More details... | |
DocumentId [] | EnumerateDocuments (DocumentId afterDocId, EnumerateDocumentsOptions options=null) |
Please also pay attention to the method EnumerateReportInfos(EnumerateReportsOptions), which allows you to immediately get information about the results of the check. List the document IDs. IDs are listed in bundles - in options you can specify the size of the bundle. To get the next batch, you need to specify the ID of the last document in the received batch. More details... | |
CompanyStats | GetCompanyStats () |
Get statistics on loaded documents. More details... | |
CheckServiceInfo [] | GetCheckServices () |
Get list of checking services. More details... | |
FolderTree | GetFolders (string email) |
Get the folder tree. More details... | |
int | AddFolder (string email, string name, FolderOptions options=null) |
Add a folder. Please pay attention that the method can only be used in one stream. More details... | |
void | DeleteFolder (string email, int folderId) |
Delete the folder. More details... | |
void | RenameFolder (string email, int folderId, string name) |
Rename the folder. More details... | |
void | MoveFolder (string email, int folderId, int parentId) |
Move the folder. More details... | |
void | MoveDocuments (string email, int folderId, DocumentId[] docIds) |
Move the documents to another folder. More details... | |
TariffInfo | GetTariffInfo () |
Returns information about the current tariff plan. More details... | |
ExportReportInfo | ExportReportToPdf (DocumentId docId, ExportReportOptions options=null) |
Export PDF report. More details... | |
byte [] | GetVerificationReport (DocumentId docId, VerificationReportOptions options=null, FormattingOptions formattingOptions=null) |
Export certificate in PDF. More details... | |
ReportInfo [] | EnumerateReportInfos (EnumerateReportsOptions options) |
Method returns list of statuses of documents checks filtered by options. options . More details... | |
void | SetIndexState (DocumentId docId, IndexState indexState) |
Set the document indexing type: add to the similarity index, add to the approved index or delete document from index. When setting the Index State value.None document stops being a source of similarity (or approved for citation) in the checks. When you change the indexing type of a document, previously made reports remain unchanged. More details... | |
ExtractTextStatus | GetTextExtractStatus (DocumentId docId) |
Get status of document text extraction. More details... | |
ExtractTextStatus [] | GetTextExtractStatuses (DocumentId[] docIds) |
Get status of documents text extraction. More details... | |
BibliographyText | GetBibliographyText (DocumentId docId) |
Extract marked up text of the bibliography. More details... | |
TimeSpan | Ping () |
Check the availability of the service. More details... | |
Contract for working with the system API Antiplagiat.
int Antiplagiat.ApiCorp.IApiCorp.AddFolder | ( | string | email, |
string | name, | ||
FolderOptions | options = null |
||
) |
Add a folder. Please pay attention that the method can only be used in one stream.
E-mail of the user. Empty string means storage. | |
name | Name of the folder. |
options | Options of addition. |
UserNotFoundException | The user with the specified e-mail email was not found. |
InvalidArgumentException |
|
ApiCorpException | Internal service error. |
void Antiplagiat.ApiCorp.IApiCorp.CheckDocument | ( | DocumentId | docId, |
string [] | checkServicesList, | ||
CheckDocParams | checkDocParameters = null |
||
) |
Start document check.
docId | Document ID |
checkServicesList | List of codes of checking services check by which is required. It can be null - in this case search occurs by all the available collections. |
checkDocParameters | Similarity search settings. |
DocumentIdException | Invalid document ID |
InvalidArgumentException |
|
PermissionException | This check can't be started due to the restrictions of the current tariff. |
ImmediateException | The check of the specified document cannot be started at the moment |
ApiCorpException | Internal service error. |
void Antiplagiat.ApiCorp.IApiCorp.DeleteDocument | ( | DocumentId | docId | ) |
Delete a previously uploaded document. If an external identifier was set for a document, then after deletion this external identifier is released (it can be used to identify another document). When you delete a document, the audit reports for this document are also deleted. When a document is deleted, it is automatically deleted from the index. When deleting a document, the reports made before deletion, in which the document appears as a source, remain unchanged.
docId | Document ID |
DocumentIdException | Invalid document ID |
InvalidArgumentException | The argument isn't specifieddocId |
ImmediateException | The operation cannot be performed at the moment. For example, the current check has not been completed for this document |
ApiCorpException | Internal service error. |
void Antiplagiat.ApiCorp.IApiCorp.DeleteFolder | ( | string | email, |
int | folderId | ||
) |
Delete the folder.
E-mail of the user. Empty string means storage. | |
folderId | Folder ID |
UserNotFoundException | The user with the specified e-mail email was not found. |
InvalidArgumentException | Invalid value is set folderId. The folder with specified ID doesn't exist. |
ApiCorpException | Internal service error. |
DocumentId [] Antiplagiat.ApiCorp.IApiCorp.EnumerateDocuments | ( | DocumentId | afterDocId, |
EnumerateDocumentsOptions | options = null |
||
) |
Please pay attention also to the method EnumerateReportInfos(EnumerateReportsOptions), which allows you to immediately get information about the results of the check. List the document IDs. Identifiers are listed in bundles - in options you can specify the size of the bundle. To get the next bundle, you need to specify the ID of the last document in the received bundle.
afterDocId | ID of the last document from previous bundle. In case of null enumeration starts from the beginning of the list of uploaded documents |
options | Enumeration options |
DocumentIdException | Invalid document ID |
InvalidArgumentException |
|
UserNotFoundException | The user with e-mail options.FromUser is not found. |
ApiCorpException | Internal service error. |
ReportInfo [] Antiplagiat.ApiCorp.IApiCorp.EnumerateReportInfos | ( | EnumerateReportsOptions | options | ) |
Method returns list of statuses of documents filtered by options .
options | Parameters of check results filtration |
ExportReportInfo Antiplagiat.ApiCorp.IApiCorp.ExportReportToPdf | ( | DocumentId | docId, |
ExportReportOptions | options = null |
||
) |
Export report in PDF.
docId | Document ID |
options | Options of report export. |
DocumentIdException | Invalid document ID. |
InvalidArgumentException |
|
PermissionException | Reserved for future tariffs. |
ApiCorpException | Internal service error. |
BibliographyText Antiplagiat.ApiCorp.IApiCorp.GetBibliographyText | ( | DocumentId | docId | ) |
Extract marked up text of the bibliography.
docId | Document ID. |
DocumentIdException | Invalid document ID. |
InvalidArgumentException | The argument docId is not set. |
ApiCorpException | Internal service error. |
ImmediateException | Method can't be called at the moment (text extraction is not completed or method is called too often for the same document). |
PermissionException | The company doesn't have access to the specified method. |
CheckServiceInfo [] Antiplagiat.ApiCorp.IApiCorp.GetCheckServices | ( | ) |
Get the list of checking services.
ApiCorpException | Internal service error. |
CheckStatus Antiplagiat.ApiCorp.IApiCorp.GetCheckStatus | ( | DocumentId | docId | ) |
Get status of the last document check.
docId | Document ID |
DocumentIdException | Invalid document ID |
InvalidArgumentException |
|
ApiCorpException | Internal service error. |
CheckStatus [] Antiplagiat.ApiCorp.IApiCorp.GetCheckStatuses | ( | DocumentId [] | docIds | ) |
Get last check report status for documents from the specified list
docIds | List of documents for receiving the last check status |
DocumentIdException | The list docIds contains invalid document ID |
InvalidArgumentException |
|
ApiCorpException | Internal service error. |
CompanyStats Antiplagiat.ApiCorp.IApiCorp.GetCompanyStats | ( | ) |
Get statistics on the uploaded documents.
ApiCorpException | Internal service error. |
DocInfo Antiplagiat.ApiCorp.IApiCorp.GetDocumentInfo | ( | DocumentId | docId, |
InfoOptions | options = null |
||
) |
Get information about the document. Parameter options specifies what information interests.
docId | Document ID |
options | Content of required information about the document |
DocumentIdException | Invalid document ID |
InvalidArgumentException |
|
ApiCorpException | Internal service error. |
DocInfo [] Antiplagiat.ApiCorp.IApiCorp.GetDocumentsInfo | ( | DocumentId [] | docIds, |
InfoOptions | options = null |
||
) |
Get information about the list of documents. Parameter options specifies what information interests.
docIds | List of document IDs |
options | Content of required information about the document |
DocumentIdException | List docIds contains invalid document ID. |
InvalidArgumentException |
|
ApiCorpException | Internal service error. |
string Antiplagiat.ApiCorp.IApiCorp.GetDocumentText | ( | DocumentId | docId | ) |
Get text of the document.
docId | Document ID |
DocumentIdException | Invalid document ID |
InvalidArgumentException |
|
ApiCorpException | Internal service error. |
FolderTree Antiplagiat.ApiCorp.IApiCorp.GetFolders | ( | string | ) |
Get folder tree.
E-mail of user. Empty string means storage. |
UserNotFoundException | User with specified e-mail email is not found. |
ApiCorpException | Internal service error. |
ReportSummary [] Antiplagiat.ApiCorp.IApiCorp.GetReportHistory | ( | DocumentId | docId | ) |
Get document report history.
docId | Document ID. |
DocumentIdException | Invalid document ID |
InvalidArgumentException |
|
ApiCorpException | Internal service error. |
ReportView Antiplagiat.ApiCorp.IApiCorp.GetReportView | ( | DocumentId | docId, |
ReportViewOptions | options = null |
||
) |
Get check report
docId | Document ID. |
options | Report options |
DocumentIdException | Invalid document ID |
InvalidArgumentException |
|
PermissionException | Reserved for future tariffs. |
ApiCorpException | Internal service error. |
ReportDetails Antiplagiat.ApiCorp.IApiCorp.GetSourceView | ( | DocumentId | docId, |
int | reportNum, | ||
long | srcHash, | ||
SourceViewOptions | options = null |
||
) |
Get information about the source in the report.
docId | Document ID. |
reportNum | Report number |
srcHash | Source ID in the report |
options | Options of report on source |
DocumentIdException | Invalid document ID |
InvalidArgumentException |
|
PermissionException | Reserved for future tariffs. |
ApiCorpException | Internal service error. |
TariffInfo Antiplagiat.ApiCorp.IApiCorp.GetTariffInfo | ( | ) |
Returnes information about the current tariff.
ApiCorpException | Internal service error. |
ExtractTextStatus Antiplagiat.ApiCorp.IApiCorp.GetTextExtractStatus | ( | DocumentId | docId | ) |
Get status of document text extraction.
docId | Document ID. |
DocumentIdException | Invalid document ID. |
InvalidArgumentException | Argument docId is not specified. |
ApiCorpException | Internal service error. |
ExtractTextStatus [] Antiplagiat.ApiCorp.IApiCorp.GetTextExtractStatuses | ( | DocumentId [] | docIds | ) |
Get status of documents text extraction.
docIds | List of documents to get the status of text extraction. |
DocumentIdException | List docIds contains invalid document ID. |
InvalidArgumentException |
|
ApiCorpException | Internal service error. |
byte [] Antiplagiat.ApiCorp.IApiCorp.GetVerificationReport | ( | DocumentId | docId, |
VerificationReportOptions | options = null , |
||
FormattingOptions | formattingOptions = null |
||
) |
Export certificate in PDF.
docId | Document ID. |
options | Certificate export options. |
formattingOptions | Custom options for exported document. |
DocumentIdException | Invalid document ID. |
InvalidArgumentException |
|
PermissionException | Reserved for future tariffs. |
ApiCorpException | Internal service error. |
void Antiplagiat.ApiCorp.IApiCorp.MoveDocuments | ( | string | email, |
int | folderId, | ||
DocumentId [] | docIds | ||
) |
Move documents to another folder.
User's e-mail. Empty string means storage. | |
folderId | ID of the folder in which the documents should be moved. |
docIds | IDs of documents which should be moved. |
UserNotFoundException | The user with e-mail email is not found. |
DocumentIdException | Invalid document ID. |
InvalidArgumentException |
|
ApiCorpException | Internal service error. |
void Antiplagiat.ApiCorp.IApiCorp.MoveFolder | ( | string | email, |
int | folderId, | ||
int | parentId | ||
) |
Move folder.
E-mail of the user. Empty string means storage. | |
folderId | ID of the folder being modified. |
parentId | ID of the parent folder (inside of which is going to be the modified folder). |
UserNotFoundException | User with the specified e-mail email is not found. |
InvalidArgumentException |
|
ApiCorpException | Internal service error. |
TimeSpan Antiplagiat.ApiCorp.IApiCorp.Ping | ( | ) |
Check the availability of the service.
ApiCorpException | Internal service error. |
void Antiplagiat.ApiCorp.IApiCorp.RenameFolder | ( | string | email, |
int | folderId, | ||
string | name | ||
) |
Rename the folder.
E-mail of the user. Empty string means storage. | |
folderId | ID of the folder. |
name | New name of the folder. |
UserNotFoundException | User with the e-mail email is not found. |
InvalidArgumentException |
|
ApiCorpException | Internal service error. |
DocumentId Antiplagiat.ApiCorp.IApiCorp.SetExternalId | ( | DocumentId | docId, |
String | externalId | ||
) |
Set a unique external ID for the document. As a result of the function, only the external ID changes, the internal ID does not change.
docId | Document ID |
externalId | External ID of the document which should be specified. If the value is null or "", external ID will be deleted. |
DocumentIdException | Invalid document ID |
InvalidArgumentException |
|
ApiCorpException | Internal service error. |
void Antiplagiat.ApiCorp.IApiCorp.SetIndexedStatus | ( | DocumentId | docId, |
bool | addToIndex | ||
) |
Please pay attention to the more general method SetIndexState(DocumentId, IndexState). Add a document to the similarity index or remove a document from the index. After removal from the index, the document stops being a source of similarity (or approved citation) in the checks. When deleting a document from the index, reports made before deletion will remain unchanged.
docId | Document ID. |
addToIndex | Actions with the document: true - add the document to similarity index; false - remove document from index. |
DocumentIdException | Invalid document ID. |
InvalidArgumentException | The argument docId is not specified. |
PermissionException | Adding a document to the index is not provided by the tariff. |
ApiCorpException | Internal service error. |
void Antiplagiat.ApiCorp.IApiCorp.SetIndexState | ( | DocumentId | docId, |
IndexState | indexState | ||
) |
Set the type of document indexing: add to the similarity index, add to the index of approved documents, or remove a document from the index. When setting the IndexState.None document ceases to be as a source of similarity (approved for citation) in the checks. When you change the indexing type of a document, previously made reports remain unchanged.
docId | Document ID. |
indexState | Type of indexing. |
DocumentIdException | Invalid document ID. |
InvalidArgumentException | Argument docId is not specified. |
PermissionException | Adding a document to the index is not provided by the tariff. |
ApiCorpException | Internal service error. |
DocAttributes Antiplagiat.ApiCorp.IApiCorp.UpdateDocumentAttributes | ( | DocumentId | docId, |
DocAttributes | attributes | ||
) |
Update document attributes. Only the specified attributes are changed. To remove a custom attribute, you must specify null, an empty string, or a string of spaces in its value.
docId | Document ID |
attributes | Full attributes of the document after updating |
DocumentIdException | Invalid document ID | ||
InvalidArgumentException |
|
UploadResult Antiplagiat.ApiCorp.IApiCorp.UploadDocument | ( | DocData | data, |
DocAttributes | attributes = null , |
||
UploadOptions | options = null |
||
) |
Upload of the document. Both a separate document and an archive of documents can be downloaded. For a list of supported types, see Doc Data.FileType. When downloading an archive, documents of unsupported types inside the archive are ignored.
data | Description of the uploaded file |
attributes | Attributes of the uploaded document. Filling in this field affects the display of the document in the search results (if it is added to the index), and filling in various fields in reports, references, etc. If an archive with several documents is loaded, these attributes are attributed to each of the documents in the archive. The file name will be formed as "archive name"\"archive file name". |
options | Optional options |
InvalidArgumentException |
|
UserNotFoundException | Argument options for the field UploadOptions.FromUser contains invalid or wrong value. |
PermissionException | User was blocked because of the suspicious activity. |
OperationDenialException | The user violated the provisions of the "Principles of Fair Use". The operation of adding a document is not available. |
ApiCorpException | Internal service error. |