BrightSign Network Web API Reference Manual v.3.8 User Manual
Page 37
25
WebPageUploadStatus StartWebPageUploadSession(array webpageAssets[], string uploadToken,
string sessionToken, string filename, long filesize, int chunksCount, enum ContentType,
string virtualPath, base64Binary fileThumb, string sha1Hash)
Description
Initializes a session for uploading a set of webpage asset files. This method accepts a set of parameters for the HTML
file similar to
StartFileUpload(). It also accepts an array of parameters for each asset file associated with the
webpage. If successful, this method will return a session token that will be utilized in each individual set of
StartFileUpload()/CompleteFileUpload() transactions.
Required Permissions
Content: Upload Content
Parameters
•
[array] webpageAssets: An array of one or more sets of WebPageAssetUploadArguments, which can
contain the following:
o [string] filename: The name of the file to be uploaded. A descriptive error will be returned if any of the
following conditions occur:
This string is empty.
The string has more than 128 characters.
The file name is not valid.
o [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.
o [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.
o [enum: Auto, Image, Video, Audio, Webpage] contentType: The type of the asset file. The
default type is Image.