Content upload, Overview – BrightSign Network Web API Reference Manual v.3.8 User Manual

Page 30

Advertising
background image

18

CONTENT UPLOAD

Overview

Content Upload methods use a separate

SOAP endpoint

from all other Web API methods. To upload a file, the client must

first call

StartFileUpload(), then call AppendChunk() one or more times, then call CompleteFileUpload(). It is

also possible to upload multiple associated webpage asset files using a session token provided by the
StartWebPageUploadSession() method. The workflow for uploading webpage assets is outlined in the following
section.

The Content Upload service allows uploading files using multiple threads in parallel. To use multi-threading, the client
must first call

StartFileUpload() and obtain an upload token. The client then uploads chunks in multiple threads

(using

AppendChunk() with different parameters), specifying the partNumber and offset for each thread along with

the same upload token. After the chunks are uploaded, the client must call

CompleteFileUpload(). The client may

also upload several different files while at the same time specifying different upload tokens.

Web Page Upload Work Flow

1. Call

StartWebPageUploadSession() using parameters for the webpage file and associated content files.

Retrieve the initialized session and upload tokens from the

WebPageUploadStatus return.

2. Call

StartFileUpload() using parameters for the webpage file, as well as the session token and primary

upload token from the

WebPageUploadStatus return. Make sure to specify the [enum]ContentType as

“Webpage”.

3. Call

AppendChunk() for the number of times needed to complete the webpage file upload. Use the session token

and primary upload token from the

WebPageUploadStatus return.

4. Call

CompleteFileUpload() using the same content upload arguments utilized in Step 2.

5. Repeat the following steps for each webpage asset file:

Advertising