API

The following operations are supported. For a formal definition, please review the Service Description.

• AccountCreateFree
  This method creates a new free user account. The method requires an API Key which you must have obtained from the web site.
• AccountLogin
  This method logs you in to your account. The method requires an API Key which you must have obtained from the web site.
• AdminCreateFolder
  Private site Administrator can add a new folder into User account.
• AdminCreateGroupShare
  Private site Administrator can create a GroupShare for a User.
• AdminUserAdd
  This operation lets the Private Site Administrator add a new User.
• AppendChunk
  Append a chunk of bytes to a file. The client must ensure that all messages are in sequence.
• AppendChunkGZip
  Similar to the regular AppendChunk method, except in this method all chunks are decompressed on the server upon receipt, using GZIP compression standard. This speeds up large file transfers significantly by compressing each chunk. Use of this method requires that you first compress all chunks using the GZIP standard. (Note: if you are using .NET, this compression method is available as the 'GZipStream' class library)
• AppendChunkWithFolderAccessKey
  Append a chunk of bytes to a file using FolderAccessKey.
• AppendComment
  Please use the ItemDescriptionAdd method. The AppendComment method expires on August 6th 2010.
• ChunkUpload
  Use the new REST API ChunkUpload method . The ChunkUpload WEBAPI method expires on April 28th 2020.
• ClientGetAddInVersion
  Returns the latest version of the Client Office Add-in
• ClientGetUploadPath
  Returns the upload path to which client applications will upload files.
• ConvertDocToPDF
  Convert Document file to PDF file.
• ConvertDocToPDFStatus
  Get the status for Document to PDF conversion.
• ConvertImage
  This function converts a saved image, to a new scale and/or rotation, and saves it to the path specified. The function returns a processid which can be queried to get the process status, since the scaling process is performed asynchronously on the server.
• ConvertImageStatus
  The function checks the status of the conversion. This function returns a string: Y = conversion in process, P = pending/queued, C = conversion complete.
• ConvertImageToPDF
  Convert images in to a PDF file.
• CopyItems
  Copies items to the clipboard for pasting
• CreateFolder
  Creates a new folder
• CutItems
  Cuts items and moves it to the clipboard for pasting
• DeleteItems
  Deletes Items
• DownloadFile
  Use the new REST API DownloadFile method. The DownloadFile WEBAPI method expires on April 28th 2020.
• FaxGetDefaults
  This function returns the defaults that were saved from your last fax.
• FaxSend
  This function sends a fax using the proprietary Web Fax Service. The function returns one or more processids which can be queried to get the fax status.
• FileAgingRule
  Add/Edit File LifeCycle and Archive rule on a folder.
• FileAgingRuleRemove
  Removes the File LifeCycle and Archive rules.
• FileProperties
  Returns the basic file properties (date and size) for a given file and path. Return values include: file size in bytes, and last modified date-time (in GMT). If no saved file is found for the given file name and path, the function returns a -1 as a return code, with 0 (zero) for the size and blank or null value for date properties.
• FileShareAppendComment
  Allows users of the FileShare link to append comments to a file.
• FileShareDownloadFiles
  Use the new REST API FileShareDownloadFiles method. The FileShareDownloadFiles WEBAPI method expires on April 28th 2020.
• FileShareGetHeaderInfo
  This method retrieves the header information for a fileshare link.
• FileShareGetItems
  This method retrieves a list of files and folders for a given path in a FileShare link.
• FileShareIndexedItemProperties
  This function indicates if the referenced file is page-indexed, for viewing in the Online Viewer. If the file is indexed, the function returns a value of 1 along with the number of indexed pages. This function can be used to check the status of a file that has been queued for indexing.
• FileShareItemImage
  Displays an image of the referenced page within the referenced file. This function only returns an image if the file is done indexing.
• FileShareItemThumbnail
  Displays a thumbnail for the item. For image files and documents indexed for the Online Viewer, the thumbnail will be a small picture of the first page of the file. For folders, a folder icon is returned.
• FileShareRequestDocIndexing
  Sends the system a request to index the referenced file. The system processes these requests in a queue. Once the document pages are indexed for viewing, the ItemImage function may be called to return the page image(s) in the file.
• GetAPIURL
  This function returns API URL.
• GetClientAppInfo
  Returns the latest info (version,download url etc.) about a client app
• GetClientID
  Provides the ClientID for a Company code
• GetCompanyDetails
  Provides the Company details for a given Domain name
• GetDropBoxDefaults
  Returns the preferred file dropbox settings.
• GetELinkDefaults
  Returns the preferred file share settings.
• GetFaxStatus
  This function returns the status of FAX
• GetFolderAccessKey
  This function returns Folder Access Key for a folder of input user
• GetImageStream
  This function returns a image stream in form of byte array for the requested image path.
• GetMediaStream
  This function returns a streaming URL for a media file. If the file is not ready for streaming then the function submits the job for streaming conversion and provides the status of the submitted job.
• GetStorageLocation
  This function returns storage locations
• GetTIFFPageCount
  This function returns a page count in TIFF & TIF image.
• GetUserParam
  This function returns the userparam for the provided token.
• GoogleOAuthAccountLogin
  This method logs you in to your account using Google Auth security token. The method requires an API Key which you must have obtained from the web site.
• GroupShareAdd
  Create a new GroupShare: shares a folder from the active session user account to a different user.
• GroupShareGetFoldersFullControl
  This function returns all the groupshare folders where this user has Full-Control permissions.
• IndexedItemProperties
  This function indicates if the referenced file is page-indexed, for viewing in the Online Viewer. If the file is indexed, the function returns a value of 1 along with the number of indexed pages. This function can be used to check the status of a file that has been queued for indexing.
• ItemAdvancedProperties
  Displays advance attributes of a folder or file. This includes: comments, keyword metatags, and the Version Control status if Version Control is enabled.
• ItemCommentAdd
  Add Comment of an Item.
• ItemCommentRemove
  Remove Comment of an Item.
• ItemCommentUpdate
  Update Comment of an Item.
• ItemCommentsList
  Get Comments list of an Item.
• ItemDescription
  Get Description of an Item.
• ItemDescriptionAdd
  Add description of an Item.
• ItemImage
  Displays an image of the referenced page within the referenced file. This function only returns an image if the file is done indexing.
• ItemProperties
  Displays basic file properties. This includes: the complete folder path, the file size and last updated date.
• ItemThumbnail
  Displays a thumbnail for the item. For image files and documents indexed for the Online Viewer, the thumbnail will be a small picture of the first page of the file. For folders, a folder icon is returned.
• LDAPAccountLogin
  This method logs you in to your account using LDAP Credentials. The method requires an API Key which you must have obtained from the web site.
• ListItems
  Please use the ListItems2 method. The ListItems method expires on September 26th 2014.
• ListUserVolumes
  Please use the ListUserVolumes2 method. The ListUserVolumes method expires on September 26th 2014.
• Login
  Please use the AccountLogin method. The Login method expires on April 15th 2008.
• Logout
  Logs you out from your account
• Paste
  Pastes items in the clipboard into the specified path
• RenameItem
  Renames an Item
• RequestDocIndexing
  Sends the system a request to index the referenced file. The system processes these requests in a queue. Once the document pages are indexed for viewing, the ItemImage function may be called to return the page image(s) in the file.
• SAMLAccountLogin
  This method logs you in to your account using SAML 2.0 security token. The method requires an API Key which you must have obtained from the web site.
• SSOLoginURL
  Provides Single Sign On Login URL of User for Client applications.
• SSOLoginWebURL
  Provides Single Sign On Login URL of User for Web applications.
• SendDropboxLink
  This operation is similar to the SendItemsElink operation. This produces a web URL that anyone, even non-members, can use to upload files to a designated folder in a user account. An email is sent by the system containing an encrypted web link, which when activated by recipients, will prompt them to Upload any files to the specified folder, according to the parameters (options) given when calling the function. If the 'RecipientsEmailAddresses' element is equal to the value 'GENERALLINK', the function will return the Dropbox URL Link without sending an email. This link can be used directly from any location, and the link behaves exactly like the way it does when sent in an email.
• SendFileShareLink
  Shares files/folders securely with anyone, even non-members, using a web URL link. An email is sent by the system containing an encrypted web link, which when activated by recipients, will prompt them to Download the shared files or folders, or view files online, according to the parameters (options) given when calling the function. If the 'RecipientsEmailAddresses' element is equal to the value 'GENERALLINK', the function will return the FileShare URL Link without sending an email. This link can be used directly from any location, and the link behaves exactly like the way it does when sent in an email. Methods SendItemsELink, SendItemsELink2 and SendItemsELink3 will become obsolete once API clients migrate to SendFileShareLink method.
• SendFileShareLinkWithDefaults
  This operation is similar to the SendFileShareLink operation, except that it uses the defaults stored in the user profile. Shares files/folders securely with anyone, even non-members, using a web URL link. An email is sent by the system containing an encrypted web link, which when activated by recipients, will prompt them to Download the shared files or folders, or view files online, according to the parameters (options) given when calling the function. If the 'RecipientsEmailAddresses' element is equal to the value 'GENERALLINK', the function will return the FileShare URL Link without sending an email. This link can be used directly from any location, and the link behaves exactly like the way it does when sent in an email.
• SendItemsELink
  This operation is similar to the SendDropboxLink operation. Shares files/folders securely with anyone, even non-members, using a web URL link. An email is sent by the system containing an encrypted web link, which when activated by recipients, will prompt them to Download the shared files or folders, or view files online, according to the parameters (options) given when calling the function. If the 'RecipientsEmailAddresses' element is equal to the value 'GENERALLINK', the function will return the FileShare URL Link without sending an email. This link can be used directly from any location, and the link behaves exactly like the way it does when sent in an email.
• SendItemsELinkWithDefaults
  Please use the SendFileShareLinkWithDefaults method. The SendItemsELinkWithDefaults method expires on March 1st 2022.
• UpdateFolderProperties
  Sets folder properties such as file version history and check-in/check-out.
• UploadFile
  Use the new REST API UploadItem method. The UploadFile WEBAPI method expires on April 28th 2020.
• UploadFileWithFolderAccessKey
  Upload a file using Folder Access Key
• UserAdd
  This operation lets the Private Site Administrator add a new User. Please use the AdminUserAdd method. The UserAdd method expires on April 20th 2020.
• ViewFile
  Provides a URL from which a file can be view.