BrightSign Network Web API User Manual
API REFERENCE MANUAL
BrightSign Network Version 3.8
BrightSign, LLC. 16795 Lark Ave., Suite 200 Los Gatos, CA 95032 | 408-852-9263 | www.brightsign.biz
TABLE OF CONTENTS
Introduction .......................................................................................................................... 1
Entities .............................................................................................................................................................................. 1
Identifiers ................................................................................................................................................................................................................ 1
Dependency ........................................................................................................................................................................................................... 1
Methods ............................................................................................................................................................................ 2
Entity Retrieval Methods ........................................................................................................................................................................................ 2
Entity Update Methods ........................................................................................................................................................................................... 3
Object Permissions ......................................................................................................................................................... 4
SOAP Endpoints .............................................................................................................................................................. 4
SOAP Access Point URLs ............................................................................................................................................... 5
User Authentication......................................................................................................................................................... 6
Development Tools ......................................................................................................................................................... 6
User Authenticate() ................................................................................................................................................................................................ 6
Content .................................................................................................................................. 7
Content Entity .................................................................................................................................................................. 7
ContentFolder Entity ....................................................................................................................................................... 8
ContentType Enumeration .............................................................................................................................................. 8
ContentTransition Enumeration ..................................................................................................................................... 8
DynamicPlaylistContent Entity-Relation ....................................................................................................................... 9
PresentationContent Entity-Relation ........................................................................................................................... 10
DynamicPlaylistInfo Structure ...................................................................................................................................... 11
PresentationInfo Structure ........................................................................................................................................... 11
Content Management Web Methods ............................................................................................................................ 11
PagedList<Content> GetAllContent(string marker, int pageSize) ....................................................................................................................... 12
List<ContentFolder> GetContentFolders(string virtualPath) ................................................................................................................................ 12
PagedList<Content> GetFolderContent(string virtualPath, string marker, int pageSize) .................................................................................... 13
List<Content> GetSpecifiedContent(int[] contentIds) .......................................................................................................................................... 13
PagedList<Content> FindContent(string fileNamePattern, string marker, int pageSize) .................................................................................... 14
Content GetContent(int contentId) ....................................................................................................................................................................... 14
ContentFolder CreateContentFolder(ContentFolder entity) ................................................................................................................................. 15
bool MoveContent(int[] contentIds, string newVirtualPath) .................................................................................................................................. 15
bool CheckContentUsage(int contentId) .............................................................................................................................................................. 16
bool DeleteContent(int[] contentIds) .................................................................................................................................................................... 17
Content Upload .................................................................................................................. 18
Overview ......................................................................................................................................................................... 18
Web Page Upload Work Flow ....................................................................................................................................... 18
Web Page Update Work Flow ....................................................................................................................................... 19
Content Upload Web Methods ...................................................................................................................................... 20
ContentUploadStatus StartFileUpload(string uploadToken, string sessionToken, string filename, long filesize, int chunksCount, enum
ContentType, dateTime fileLastModifiedDate, string virtualPath, base64Binary fileThumb, string sha1Hash) .................................................. 21
ContentUploadStatus AppendChunk(string uploadToken, int partNumber, binary data, long offset) ................................................................. 22
ContentUploadStatus CompleteFileUpload(string uploadToken, string sessionToken, string filename, long filesize, int chunksCount, enum
ContentType, dateTime fileLastModifiedDate, string virtualPath, base64Binary fileThumb, string sha1Hash) .................................................. 23
WebPageUploadStatus StartWebPageUploadSession(array webpageAssets[], string uploadToken, string sessionToken, string filename, long
filesize, int chunksCount, enum ContentType, string virtualPath, base64Binary fileThumb, string sha1Hash) .................................................. 25
WebPageUploadStatus CompleteWebPageUploadSession(array webpageAssets[], string sessionToken, string filename, long filesize, int
chunksCount, enum ContentType, string virtualPath, base64Binary fileThumb, string sha1Hash) .................................................................... 27
ContentUploadStatus CancelFileUpload(string uploadToken) ............................................................................................................................ 29
ContentUploadStatus GetFileUploadStatus(string uploadToken) ....................................................................................................................... 29
WebPageUploadStatus GetWebPageUploadStatus(string sessionToken) ......................................................................................................... 30
Dynamic Playlist ................................................................................................................. 31
ImageVideoDynamicPlaylist Entity .............................................................................................................................. 31
AudioDynamicPlaylist Entity ........................................................................................................................................ 31
Dynamic Playlist Management Web Methods ............................................................................................................. 32
PagedList<DynamicPlaylist> GetDynamicPlaylists(string marker, int pageSize) ................................................................................................ 33
PagedList<ImageVideoDynamicPlaylist> GetImageVideoDynamicPlaylists(string marker, int pageSize) ......................................................... 34
PagedList<AudioDynamicPlaylist> GetAudioDynamicPlaylists(string marker, int pageSize) ............................................................................. 34
List<DynamicPlaylist> GetSpecifiedDynamicPlaylists(int[] dynamicPlaylistIds) .................................................................................................. 35
PagedList<DynamicPlaylist> FindDynamicPlaylists(string namePattern, string marker, int pageSize) .............................................................. 35
PagedList<ImageVideoDynamicPlaylist> FindImageVideoDynamicPlaylists(string namePattern, string marker, int pageSize) ....................... 36
PagedList<AudioDynamicPlaylist> FindAudioDynamicPlaylists(string namePattern, string marker, int pageSize) ........................................... 37
DynamicPlaylist GetDynamicPlaylist(int dynamicPlaylistId, bool loadContent) ................................................................................................... 38
DynamicPlaylist GetDynamicPlaylistByName(string name, bool loadContent) ................................................................................................... 38
bool CheckDynamicPlaylistName(string name) ................................................................................................................................................... 39
bool CheckDynamicPlaylistUsage(int dynamicPlaylistId) .................................................................................................................................... 39
bool CheckDynamicPlaylistUsageByName(string name) .................................................................................................................................... 40
DynamicPlaylist CreateDynamicPlaylist(DynamicPlaylist entity) ......................................................................................................................... 40
bool UpdateDynamicPlaylist(DynamicPlaylist entity) ........................................................................................................................................... 41
bool RenameDynamicPlaylist(int dynamicPlaylistId, string newName) ............................................................................................................... 42
bool DeleteDynamicPlaylists(int[] dynamicPlaylistIds) ......................................................................................................................................... 42
Live Text Feed .................................................................................................................... 44
LiveTextFeed Entity ....................................................................................................................................................... 44
LiveTextFeedItem Entity-Relation ................................................................................................................................ 44
Live Text Feed Management Web Methods ................................................................................................................. 45
PagedList<LiveTextFeed> GetLiveTextFeeds(string marker, int pageSize) ....................................................................................................... 45
List<LiveTextFeed> GetSpecifiedLiveTextFeeds(int[] liveTextFeedIds) ............................................................................................................. 46
PagedList<LiveTextFeed> FindLiveTextFeeds(string namePattern, string marker, int pageSize) ..................................................................... 46
LiveTextFeed GetLiveTextFeed(int liveTextFeedId, bool loadContent) .............................................................................................................. 47
LiveTextFeed GetLiveTextFeedByName(string name, bool loadContent) .......................................................................................................... 48
bool CheckLiveTextFeedName(string name) ...................................................................................................................................................... 48
bool CheckLiveTextFeedUsage(int liveTextFeedId) ............................................................................................................................................ 49
bool CheckLiveTextFeedUsageByName(string name) ........................................................................................................................................ 49
LiveTextFeed CreateLiveTextFeed(LiveTextFeed entity) .................................................................................................................................... 50
LiveTextFeed CloneLiveTextFeed(string feedUrl) ............................................................................................................................................... 50
bool UpdateLiveTextFeed(LiveTextFeed entity) .................................................................................................................................................. 51
bool RenameLiveTextFeed(int liveTextFeedId, string newName) ....................................................................................................................... 52
bool DeleteLiveTextFeeds(int[] liveTextFeedIds)................................................................................................................................................. 52
Live Media Feed ................................................................................................................. 53
LiveMediaFeed Entity .................................................................................................................................................... 53
LiveMediaFeedContent Entity-Relation ....................................................................................................................... 53
Live Media Feed Management Web Methods .............................................................................................................. 54
PagedList<LiveMediaFeed> GetLiveMediaFeeds(string marker, int pageSize) ................................................................................................. 55
List<LiveMediaFeed> GetSpecifiedLiveMediaFeeds(int[] liveMediaFeedIds) ..................................................................................................... 55
PagedList<LiveMediaFeed> FindLiveMediaFeeds(string namePattern, string marker, int pageSize) ................................................................ 56
Loading...