https://help.onea.be/index.php?action=history&feed=atom&title=Webservices 2026-04-04T02:28:43Z Revision history for this page on the wiki MediaWiki 1.27.1 https://help.onea.be/index.php?title=Webservices&diff=2425&oldid=prev 2018-08-07T09:16:16Z

<p>Created page with &quot;==FileUploadService== Used to prepare a file upload to 1Archive. It contains different methods which differ on the way of authentication: * &#039;&#039;&#039;prepareFileUpload&#039;&#039;&#039;: requires...&quot;</p> <p><b>New page</b></p><div>==FileUploadService==<br /> <br /> Used to prepare a file upload to 1Archive. It contains different methods which differ on the way of authentication:<br /> * '''prepareFileUpload''': requires a 1Archive login and password to authenticate<br /> ** ''userword'': not a username, but a userword (this should be the 1Archive username)<br /> ** ''password'': the 1Archive password<br /> ** ''contenttype'': specify the content type of the file to upload<br /> ** ''filesize'': specify the size of the file to upload<br /> * '''prepareScanFileUpload''': requires a batchid code. This method is used for webscanning upload<br /> ** ''batchid'': the id of a scanning batch<br /> ** ''filename'': specify the name of the file to upload<br /> ** ''contenttype'': specify the content type of the file to upload<br /> ** ''filesize'': specify the size of the file to upload<br /> <br /> ==FileUpload==<br /> <br /> Used to upload files to 1Archive.<br /> <br /> * ''id'': the id of the upload connection, can be obtained via '''[[Webservices#FileUploadService|FileUploadService]]'''<br /> <br /> ==ScanProService==<br /> <br /> Used for uploading documents to 1Archive. For authentication, the 1Archive username and password are used.<br /> * '''checkConnection''': can be used to check if username and password are correct (note that username and password will be sent as plain text)<br /> ** ''username'': the 1Archive username<br /> ** ''password'': the 1Archive password<br /> * '''getCompanies''': returns a list of companies assigned to the given user<br /> ** ''username'': the 1Archive username<br /> ** ''password'': the 1Archive password<br /> * '''getDocumentTypes''': returns a list of document types for the company with code ''companyCode'' (which can be obtained via the '''getCompanies''' call<br /> ** ''username'': the 1Archive username<br /> ** ''password'': the 1Archive password<br /> ** ''companyCode'': the code for the company to get the document types for<br /> * '''prepareFileUpload''': this is a link to the '''prepareFileUpload''' call in the '''[[Webservices#FileUploadService|FileUploadService]]'''<br /> * '''uploadDocument''': used to upload a document to 1Archive<br /> ** ''username'': the 1Archive username<br /> ** ''password'': the 1Archive password<br /> ** ''document'': ScanProDocument object<br /> * '''uploadDocumentAndAnnotate''': used to upload a document to 1Archive and annotate it<br /> ** ''username'': the 1Archive username<br /> ** ''password'': the 1Archive password<br /> ** ''document'': ScanProDocument object<br /> <br /> ==Webscanning==<br /> <br /> SOAP webservice for the webscanning application.<br /> * '''getBatchInfo'''<br /> ** ''scanbatchUniqueID'': the id of a scanning batch<br /> * '''checkUploadAllowed'''<br /> ** ''scanbatchUniqueID'': the id of a scanning batch<br /> * '''fileCheck'''<br /> ** ''scanbatchUniqueID'': the id of a scanning batch<br /> ** ''tempUploadID'': upload id, which can be obtained via the '''[[Webservices#FileUploadService|FileUploadService]]'''<br /> * '''uploadDocuments'''<br /> ** ''scanbatchUniqueID'': the id of a scanning batch<br /> ** ''transferxml'': document as ScanProModtransfer xml<br /> * '''createScanBatch'''<br /> ** ''scanbatchType'': method for standalone webscanning<br /> * '''validateScanBatchCode'''<br /> ** ''scanbatchCode'': method for standalone webscanning<br /> <br /> ==CloudService==<br /> <br /> REST service for PrivateCloud utility.<br /> * '''action''': possible values are:<br /> ** ''RequestFileUpload''<br /> ** ''FileUpload''<br /> ** ''Alive''<br /> ** ''GetPublicKey''<br /> ** ''GetDBUpdateData''<br /> <br /> ==SyncService==<br /> <br /> SOAP service for importing and exporting with authentication based on a preshared key.<br /> * '''serverTime''': used to obtain the time of the server, used in synchronization to check time difference<br /> * '''lastSyncTime''': used to retrieve date and time of the last synchronization for a certain type and company<br /> ** ''syncId'': the unique synchronization id<br /> ** ''companyCode'': the code for the company<br /> ** ''syncDirection'': the direction for the synchronization. Possible values are:<br /> *** ''UPLOAD''<br /> *** ''DOWNLOAD''<br /> ** ''syncType'': the type of synchronization. Possible values are:<br /> *** ''COMPANY''<br /> *** ''PARTNERGROUP''<br /> *** ''PARTNER''<br /> *** ''DELIVERYMETHOD''<br /> *** ''RECEPTIONMETHOD''<br /> *** ''OPTINCONNECTION''<br /> *** ''USER''<br /> *** ''LOOKUPLIST''<br /> *** ''LOOKUPLISTITEM''<br /> *** ''DOCUMENT''<br /> * '''importXml''': used to import data to 1Archive<br /> ** ''syncId'': the unique synchronization id<br /> ** ''data'': a Base64 encoded ScanProModtransfer xml<br /> * '''exportXml''': used to export data from 1Archive<br /> ** ''syncId'': the unique synchronization id<br /> ** ''syncType'': the type of synchronization. Possible values are:<br /> *** ''COMPANY''<br /> *** ''PARTNERGROUP''<br /> *** ''PARTNER''<br /> *** ''DELIVERYMETHOD''<br /> *** ''RECEPTIONMETHOD''<br /> *** ''OPTINCONNECTION''<br /> *** ''USER''<br /> *** ''LOOKUPLIST''<br /> *** ''LOOKUPLISTITEM''<br /> *** ''DOCUMENT''<br /> ** ''companyCode'': the code for the company<br /> <br /> ==ExportService==<br /> <br /> SOAP export service.<br /> <br /> * '''getDocument''': used to get a document by id as a ScanProModtransfer xml<br /> ** ''username'': the 1Archive username<br /> ** ''password'': the 1Archive password<br /> ** ''docId'': the id of the document in 1Archive<br /> * '''getAttachment''': used to get an attachment by id as a ScanProModtransfer xml<br /> ** ''username'': the 1Archive username<br /> ** ''password'': the 1Archive password<br /> ** ''attachmentId'': the id of the attachment of the document</div>

Nele.scherrens