_docuBoxCN
This is the WEB SERVICE CONNECTOR, needed to remotely handle all server's functions using SOAP in a completely standard web services environment.
The following operations are supported. For a formal definition, please review the Service Description.
-
InsDocInBinder
MessageName="AddDocsToBinder"
Insert the specified DOCUMENT-ID list in the specified BINDER-ID. -
AddUpdThumb
MessageName="AddOrUpdateThumbnail"
Create or update thumbnails for the document. -
AdminCx
Administrative service 3. -
AdminXc
Administrative service 1. -
AdminXp
Administrative service 2. -
UpdFile
MessageName="ChangeDocumentFileData"
Changes data details of a specific version of an existing DOCUMENT. -
UpdDocType
MessageName="ChangeDocumentType"
Changes the DocuBoxDocumentType of an existing DOCUMENT. Ex:string[] NEWFieldsAndValues=new string[]{"NAME0=VALUE0","NAME1=VALUE1"}; -
ChngUserPwd
MessageName="ChangePassword"
Put User Details -
sendMessage
MessageName="ChatMessageSend"
Send a chat message to a users -
getMessages
MessageName="ChatMessagesGet"
Get chat messages -
getConnectedUsersList
MessageName="ChatUsersList"
Chat users -
ClientLogout
Must be used from the clients before it stop running. [NOTE] Client connections are limited. -
CloneDoc
MessageName="CloneDocument"
Clone a DOCUMENT sharing the same phisical binary - and returns back the newly DOCUMENT-ID. -
CpyBin
MessageName="CopyBinder"
Create a copy of the Binder in the FOLDER-ID Folder. -
CpyDoc
MessageName="CopyDocument"
Create a copy of the document in the FOLDER-ID Folder. -
CpMvFolder
MessageName="CopyOrMoveFolder"
Copy or Move a FOLDER from a place to a parent FOLDER, even in another STORAGE. -
CrtBinder
MessageName="CreateBinder"
Create a specific binder, using a document id list, and returns the BINDER-ID. -
CreateDoc
MessageName="CreateDocument"
Create a new DOCUMENT and returns back the newly DOCUMENT-ID. -
CrFolderPrv
MessageName="CreatePrivFolder"
Create a FOLDER that will be private for the given GROUP-ID and returns back the newly ID. -
CrStoragePrv
MessageName="CreatePrivStorage"
Create a STORAGE that will be private for the given GROUP-ID and returns back the newly ID. -
CrFolderPub
MessageName="CreatePubFolder"
Create a PUBLIC FOLDER and returns back the newly ID. -
CrStoragePub
MessageName="CreatePubStorage"
Create a PUBLIC STORAGE and returns back the newly ID. -
CreateToken
User Authentication Token from v2.5.8 and over:returns a security token needed for all the other functions. [NOTE] To known what data is needed to send, consult the programmers manual inside the web application. [!] WARNING: it is valid for at least half an hour. -
DelBinder
MessageName="DeleteBinder"
Remove the specified BINDER-ID from a specific FOLDER-ID. -
DeleteDoc
MessageName="DeleteDocument"
Removes the document from the specificed FOLDER-ID. -
ExecDocProtoSrc
MessageName="DoDocumentProtoSearch"
Find the document having with the given register number. -
ExecDocSrc
MessageName="DoDocumentSearch"
Execute a free text document search. -
ExecDocSrcStor
MessageName="DoDocumentSearchOnStorage"
Execute a free text document search. -
DoTrovatoSearch
Execute a free text document search using Trovato! engine and resultset. -
DocExists
Returns informations about the document existence inside a storage-folder and-or using the given hash. -
UplFile
MessageName="DocumentUpload"
Upload one or more FILE(s) and create or update one or more DOCUMENT(s) (see 'GetDocumentUploadDataDesign' and the manual for the right DocumentDataset format). -
DownloadChunk
Returns (download) a file part from the specified offset for the given version of the DOCUMENT. -
DownloadChunk2
Returns (download) a file part from the specified offset for the given version of the DOCUMENT. -
EndChunkedUploadComp1
MessageName="EndChunkedUpdate"
Update a file to an existing document. -
EndChunkedUploadComp2
MessageName="EndChunkedUpdate2"
Update a file to an existing document. It is possible to load a text content in a zipped format. -
EndChunkedUpload
End a transaction that identifies a multiple file part upload. -
EndChunkedUpload_AsyQry
Asynchronous EndChunkedUpload - QUERY STATUS. -
EndChunkedUpload_AsyStart
Asynchronous EndChunkedUpload - START. -
FindDocByProps
Returns a list of document which contains the given value in the given property. -
GetTokenId
MessageName="GenerateToken"
User Authentication Token DEPRECATED from v3.x.x:returns a security token needed for all the other functions. [NOTE] To known what data is needed to send, consult the programmers manual inside the web application. [!] WARNING: it is valid for at least half an hour. -
GetAppsGroups
Get User Groups Details -
DwBndZip
MessageName="GetBinderBinary"
Returns a ZIP file with all the files inside the BINDER-ID (FASCICOLO-ID). -
BndCont
MessageName="GetBinderContent"
BINDER (FASCICOLO) data. -
BndData
MessageName="GetBinderDetailsAndContent"
BINDER (FASCICOLO) data and contained files list. -
GetConfig
Returns the system config info, needed for some clients operations. -
GetDocLog
Get the document log about the given document-id. This will reply to the document user proprietor or the administrator. -
GetDocProtoRecs
Returns all register number for the given Doc-id. -
DwThumb
MessageName="GetDocThumbnail"
Returns (download) the thumbnail image for the given DOCUMENT-ID. -
DwDocument
MessageName="GetDocumentBinary"
Returns (download) the actual file for the DOCUMENT. -
DocData
MessageName="GetDocumentDetails"
DOCUMENT data. The use of DoNotExecDynamicProperties flag is detailed in the programming manual. -
DocDataExt
MessageName="GetDocumentDetailsExtended"
DOCUMENT data. The use of DoNotExecDynamicProperties flag is detailed in the programming manual. -
GetLockInfo
MessageName="GetDocumentLockInfo"
Returns an XML that reports the information about the document locking. -
GetDocTypeDetails
MessageName="GetDocumentTypeDetail"
Returns the configured DOCUMENT TYPE FIELDS for the given DOCUMENT-TYPE-ID. -
GetDocTypesList
MessageName="GetDocumentTypes"
Returns the DOCUMENT TYPES list, stored in this server. -
UplFileDtDesign
MessageName="GetDocumentUploadDataDesign"
Returns a dataset that contains the empty DataTable needed to be filled before calls the DocumentUpload webMethod. -
DwFile
MessageName="GetDocumentVersionBinary"
Returns (download) the file for the given version of the DOCUMENT. -
DocVersion
MessageName="GetDocumentVersions"
DOCUMENT versions data. -
DwFdThumb
MessageName="GetFidaThumbnail"
Returns (download) the thumbnail image for the given DOCUMENT/Version-ID. -
GetFile
Returns the user accessible FILE using FILE-ID inside the given FOLDER-ID. -
FilesList
MessageName="GetFiles"
Returns all the user accessible FILES inside the given FOLDER-ID. -
GetFolderDetails
Returns data about a folder using the given FOLDER-ID. -
GetFolderDetailsWSize
Returns data and size info about a folder using the given FOLDER-ID. -
FoldersList1
MessageName="GetFolders"
Returns all the user accessible FOLDERS inside the given STORAGE-ID. Messages in us-EN. -
GetFolderByPath
MessageName="GetFoldersByPath"
Returns the FOLDER for the given PATH on the STORAGE-ID. -
FoldersList1Cult
MessageName="GetFolders_Cult"
Returns all the user accessible FOLDERS inside the given STORAGE-ID. Messages in the given culture. -
GetFolderstateUuid
Returns an unique code for folder (FOLDER-ID) actual state, needed to check folder future updates. -
getLastOperationsInfo
MessageName="GetLastOperationsInfo"
Get the last operations from users for control table. -
GetNewRegisterNumber
Generate a new document -register unique id number- using a specific register, direction and year. -
FoldersList2
MessageName="GetPartialFolders"
Returns all the user accessible FOLDERS inside the given STORAGE-ID and PARENT-FOLDER-ID. Messages in us-EN. -
FoldersList2Cult
MessageName="GetPartialFolders_Cult"
Returns all the user accessible FOLDERS inside the given STORAGE-ID and PARENT-FOLDER-ID. Messages in the given culture. -
GetProtoInfo
Returns all info about the given register number. -
GetProtoRecords
Returns all records about a specific register. -
GetProtocolRegistersList
Returns the list of the registers (for register numbers) in the database. -
GetStorGroups
Get Storage/Folder User Groups Details -
GetStorageDetails
Returns data about a storage using the given STORAGE-ID. -
GetStorageSvcFolders
Returns the SERVICE FOLDER INFO for the given STORAGE-ID. -
StoragesList
MessageName="GetStorages"
Returns all the user accessible STORAGES list. -
GetSummary
Returns the internal data summary. -
GetUserBackupStorageID
Get st-id for the user backup storage -
GetMeaningGroups
MessageName="GetUserGroups"
Get the usergroups used by the application. -
GetUsrDetails
Get User Details -
GetVersion
Get application interface version. -
Handshake
Internal User authentication process webmethod. -
IsFolderstateChanged
Check is the given folder (FOLDER-ID) has a statechange from the last GetFolderstateUuid generation. -
LockDoc
MessageName="LockDocument"
Locks the document and reject all the update operations for other users. -
MveBin
MessageName="MoveBinder"
Copy the Binder in a new location (FOLDER-ID) and remove from old Folder. -
MveDoc
MessageName="MoveDocument"
Copy the Document in a new location (FOLDER-ID) and remove from old Folder. -
MvFolder
MessageName="MoveFolder"
(OBSOLETE, see CopyOrMoveFolder) Move a FOLDER from a STORAGE to a parent FOLDER in another STORAGE. -
GetOneShotDocDownloadID
MessageName="OneShotDocDownloadID"
Get a one shot id for document download (if the user can access it) -
PR_GetConfig
Returns the SRV CONFIG needed for some client operations. -
PR_GetDocTypeDetails
MessageName="PR_GetDocumentTypeDetail"
Returns the configured DOCUMENT TYPE FIELDS for the given DOCUMENT-TYPE-ID. -
PR_GetDocTypesList
MessageName="PR_GetDocumentTypes"
Returns the DOCUMENT TYPES list, stored in this server. -
RemDocFromBinder
MessageName="RemoveDocFromBinder"
Remove the specified DOCUMENT-ID from the specified BINDER-ID. -
RemoveFolderAsyncStart
Start an asynchronous FOLDER TREE deletion command. All folder contents (documents and binders) will be moved to the STORAGE TRASH folder. -
RemoveFolderAsync_Query
Query the asynchronous thread that are deleting the tree. -
RmStorage
MessageName="RemoveStorage"
Delete an EMPTY STORAGE. You must delete all contents (all folders) before delete the storage. -
RenameDocFilename
Rename the filename of the last file for the existing DOCUMENT. -
ResetGroups
Internal Administrative Command -
StartChunkedUpload
Start a transaction that identifies a multiple file part upload. Returns the Transaction Id. -
UnlockDoc
MessageName="UnlockDocument"
Unlocks a previous locked document. This can be done from the orginal locker or from an admin user. -
UpdDocComment
MessageName="UpdateDocComment"
Update the document comment. -
UpdDocSearchText
MessageName="UpdateDocSearchText"
Update the document freeText search index. -
UpdDoc
MessageName="UpdateDocument"
Add a NEW FILE to an existing DOCUMENT. -
UpdDoc2
MessageName="UpdateDocument2"
Add a NEW FILE to an existing DOCUMENT. It is possible to load a zipped document text content. -
UpdDocTitle
MessageName="UpdateDocumentTitle"
Update title of an existing DOCUMENT. -
UpdDocFV
MessageName="UpdateDocumentTypeProperties"
Update the value of a Document_Type Properties of an existing DOCUMENT. Ex:string[] FieldsAndValues=new string[]{"NAME0=VALUE0","NAME1=VALUE1"}; -
UpFolder
MessageName="UpdateFolderData"
Updates the folder properties. -
UpStorage
MessageName="UpdateStorageData"
Updates the storage properties. -
UploadChunk
Upload a chunk from a file for a multiple file part upload. -
RemBinder
MessageName="_RemoveBinder"
Completely removes the binder from DocuBox. -
RemoveDoc
MessageName="_RemoveDocument"
Completely removes the document from DocuBox.