BrightSign Network Web API Reference Manual v.3.8 - Manual (Page 33)

21
ContentUploadStatus StartFileUpload(string uploadToken, string sessionToken, string
filename, long filesize, int chunksCount, enum ContentType, dateTime fileLastModifiedDate,
string virtualPath, base64Binary fileThumb, string sha1Hash)
Description
Initializes the content upload process by returning an upload token, which is a descriptor value that is utilized by the
AppendChunk() and CompleteFileUpload() methods. This method may also receive an upload token if it is
being used to upload a webpage file.
Required Permissions
Content: Upload Content
Parameters
•
[string] uploadToken: The token of an upload that was initialized by the StartWebPageUploadSession()
method. This parameter is only specified if the file being uploaded is a webpage file.
• [string] sessionToken: The token of an upload session initialized by the StartWebPageUploadSession()
method. This parameter enables uploading of files related to a webpage file; it should only be specified if a
webpage file or associated asset file is being uploaded.
• [string] filename: The name of the file to be uploaded. A descriptive error will be returned if any of the
following conditions occur:
o This string is empty.
o The string has more than 128 characters.
o The file name is not valid.
• [long] filesize: The size of the file in bytes. This parameter must be an unsigned integer value no greater
than 5000000000 (i.e. 5GB). A descriptive error will be returned if the value is negative.
• [int] chunksCount: The number of chunks the file consists of (starting at 1). The optimal chunk size is 256KiB.
Files that are larger than this chunk size must be split into smaller parts by the client. Multiple chunks should be
uploaded using multiple
AppendChunk() calls specifying the same upload token.