Class Antiplagiat.ApiCorp.Model.DocData

Uploaded data More details...

Properties
string	FileName [get, set]
	File name More details...
string	FileType [get, set]
	File type (file extension). The following document types are supported: ".txt", ".docx", ".html", ".htm", ".pdf", ".rtf", ".odt", ".pptx", as well as other types specified in the license to use the system. Supported archive types: ".7z", ".rar", ".zip". Supported, but strongly not recommended to download documents of the type: ".doc". More details...
byte []	Data [get, set]
	File content. The data must come to the Advacheck service in base64 encoding. It is known that the conversion is performed transparently in c#, python, php and there is nothing additional to do (pass an array of bytes). However, we came across the fact that when implementing a client on nodejs, such a transformation is not performed and we had to insert the transformation explicitly. Be careful when implementing in programming languages other than the examples. More details...
string	Encoding [get, set]
	Encoding of the file if known. The list of names of encodings is presented here http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx. The field is ignored for archives and all types of files except '.txt'. In case if the encoding is not specified, it is determined automatically. More details...
string []	Languages [get, set]
	The list of possible languages in the document. Codes of languages in format "ISO 639-1". In case if the field is not specified, the default value is 'ru'. List of supported languages: 'ru'. More details...
string	ExternalUserID [get, set]
	ID of user (in the calling information system) uploaded the document. The user can be not registered in the Advacheck system. Identifier requirements: no more than 40 characters from the beginning of the line are taken into account, one user must correspond to each identifier, one identifier must correspond to each user (one-to-one correspondence). More details...
string	DeveloperID [get, set]
	ID of the developer of the external system calling this API. It should be the same for all integrations developed by the same developer. The first 40 symbols are taken into account. More details...

Detailed description

Uploaded data

Full list of properties

Data

byte [] Antiplagiat.ApiCorp.Model.DocData.Data

getset

File content. The data must come to the Advacheck service in base64 encoding. It is known that the conversion is performed transparently in c#, python, php and there is nothing additional to do (pass an array of bytes). However, we came across the fact that when implementing a client on nodejs, such a transformation is not performed and we had to insert the transformation explicitly. Be careful when implementing in programming languages other than the examples.

DeveloperID

string Antiplagiat.ApiCorp.Model.DocData.DeveloperID

getset

ID of the developer of the external system calling this API. It should be the same for all integrations developed by the same developer. The first 40 symbols are taken into account.

Encoding

string Antiplagiat.ApiCorp.Model.DocData.Encoding

getset

Encoding of the file if known. The list of names of encodings is presented here http://msdn.microsoft.com/en-us/library/system.text.encoding.aspx. The field is ignored for archives and all types of files except '.txt'. In case if the encoding is not specified, it is determined automatically.

ExternalUserID

string Antiplagiat.ApiCorp.Model.DocData.ExternalUserID

getset

ID of user (in the calling information system) uploaded the document. The user can be not registered in the Advacheck system. Identifier requirements: no more than 40 characters from the beginning of the line are taken into account, one user must correspond to each identifier, one identifier must correspond to each user (one-to-one correspondence).

FileName

string Antiplagiat.ApiCorp.Model.DocData.FileName

getset

File name

FileType

string Antiplagiat.ApiCorp.Model.DocData.FileType

getset

File type (file extension). The following document types are supported: ".txt", ".docx", ".html", ".htm", ".pdf", ".rtf", ".odt", ".pptx", as well as other types specified in the license to use the system. Supported archive types: ".7z", ".rar", ".zip". Supported, but strongly not recommended to download documents of the type: ".doc".

Please pay attenton, that file type type must be specified with the symbol '.' as in the examples above.

Languages

string [] Antiplagiat.ApiCorp.Model.DocData.Languages

getset

The list of possible languages in the document. Codes of languages in format "ISO 639-1". In case if the field is not specified, the default value is 'ru'. List of supported languages: 'ru'.