Skip to main content
Skip table of contents

5.13 ServerTool Short Key Resources

5.13.1 ThruViewerRequest  Object

ThruViewerRequest structure contains the input fields required for web service call ViewerRequest  which returns a Short Key for the View URL tool.

Item Name

Data Type

Sample Value

Comments

SessionId

String

U6tTDWRFvEPFwkLeCu…./HtFh

Session ID for file viewing

FilePublicId

String

286YJBJMIZ24V

File id

SuccessUrl

String

http://successUrlhere.com

Success url

ErrorReportingUrl

String

http://errorUrlHere.com

Error url

Sample

SessionId=U6tTDWRF….vEPFw/HtFh&FilePublicId=286YJBJMIZ24V&SuccessUrl=http://successUrlhere.com&ErrorReportingUrl=http://errorUrlHere.com

Data Transfer Object

C#
    public class ThruViewerRequest
    {
        public string SessionId { get; set; }
        public string FilePublicId { get; set; }
        public string SuccessUrl { get; set; }
        public string ErrorReportingUrl { get; set; }
    }

5.3.12 ThruUploaderRequest Object

ThruUploaderRequest structure contains the input fields required for web service call UploaderRequest which returns a Short Key for the Upload URL tool.

Item Name

Data Type

Sample Value

Comments

SessionId

String

U6tTDWR … /HtFh

Session ID for file upload

FolderPublicId

String

286YJBJMIZ24V

Folder ID where files will be uploaded

FileFilter

String

Zip files (*.zip, *.7z, *.tar): zip, 7z, tar

string for file filtering used in file open dialog. Defines allowed types.
String format: <Description> : <extension1>, <extension2> … <extensionN>.

If parameter is not passed all files are shown.

FileFilterExceptions

String

exe, com, bat

string for file filtering used in file open dialog. Defines restricted types. String format: <extension1>, <extenstion2>…<extensionN>. Can be used with FileFilter or standalone. In case used with FileFilter, result filter will contain only allowed types not included in the FileFilterExceptions

SuccessUrl

String

http://successUrlhere.com

Success url

ErrorReportingUrl

String

http://errorUrlHere.com

Error url

Sample

SessionId=U6tTDWRFvEPFwk…../HtFh&FolderPublicId=286YJBJMIZ24V&SuccessUrl=http://success.com&ErrorReportingUrl=http://error.com &FileFilter=Zip files (*.zip, *.7z, *.tar): zip, 7z, tar

Data Transfer Object

C#
    public class ThruUploaderRequest
    {
        public string SessionId { get; set; }
        public string FolderPublicId { get; set; }
        public string SuccessUrl { get; set; }
        public string ErrorReportingUrl { get; set; }
        public string FileFilter { get; set; }
        public string FileFilterExceptions { get; set; }
    }

5.13.2 ThruDownloaderRequest Object

ThruDownloaderRequest structure contains the input fields required for web service call DownloaderRequest which returns a Short Key for the Download URL tool.

Item Name

Data Type

Sample Value

Comments

SessionId

String

U6tTD…./HtFh

Session ID for file download

FolderPublicIds

String[]

286YJBJMIZ24V

Array of folders IDs which will be downloaded. Folders are downloaded as part of  a zip archive

FilePublicIds

String[]

286YJBJMIZ24C

Array of file IDs. If multiple IDs included, files are downloaded as a zip

SuccessUrl

String

http://successUrlhere.com

Success url

ErrorReportingUrl

String

http://errorUrlHere.com

Error url

Sample

SessionId=EcnsBPo8…….bd7i/HtFh&FolderPublicIds[0]=286YJBJMIZ24V&FolderPublicIds[1]=286YJBJMIZ24N&FilePublicIds[0]=567YJBJMIZ24V&FilePublicIds[1]=999YJBJMIZ24N&SuccessUrl=http://success.com&ErrorReportingUrl=http://error.com

Data Transfer Object

C#
    public class ThruDownloaderRequest
    {
        public string SessionId { get; set; }
        public string[] FilePublicIds { get; set; }
        public string[] FolderPublicIds { get; set; }
        public string SuccessUrl { get; set; }
        public string ErrorReportingUrl { get; set; }
    }

5.13.4 ThruShortUrl Object

ThruShortUrl contains a string with the Short Key which is returned by View/Upload/Download requests and is used to call View/Upload/Download URL tools.

Item Name

Data Type

Sample Value

Comments

ShortUrl

String

4E2CH827YO6OUUQVMSM3

 

String that represents passed query string

Data Transfer Object

C#
Data Transfer Object
    public class ThruShortUrl
    {
        public string ShortUrl { get; set; }
    }
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.