BrightSign Network Web API Reference Manual v.3.8 User Manual

Page 41

Advertising
background image

29

[enum: Auto, Image, Video, Audio, Webpage] contentType: The type of the content file, which
should be specified as “Webpage”.

[string] virtualPath: The path in the BSN Library to which the file should be uploaded (the default is
“\Shared\Incoming\”). If the path does not exist, it will be created. It must also contain leading and trailing slashes
and be no longer than 128 characters.

[base64Binary] fileThumb: The optional thumbnail data as a binary attachment. This parameter will be
generated by the server if it is not specified.

[string] sha1Hash: The SHA1 hash of the webpage file. The server performs verification of the uploaded file
using the specified hash. A descriptive error will be returned if the specified hash does not match the hash value
calculated by the server. This parameter is optional; the server-side hash verification process is skipped if this
parameter is not specified.

ContentUploadStatus CancelFileUpload(string uploadToken)

Description
Cancels the specified content upload and deletes all uploaded file chunks. This method returns status information
about the cancelled content upload.

Required Permissions
None

Parameters

[string] uploadToken: The token of the content upload that should be cancelled. If the content upload with
the specified token does not exist, the method will immediately return Null without error.

ContentUploadStatus GetFileUploadStatus(string uploadToken)

Description
Returns general information and upload status information about the content file associated with the specified upload
token.

Advertising