BrightSign Network Web API Reference Manual v.3.8 User Manual

Page 25

Advertising
background image

13

Parameters

[string] virtualPath: The virtual path of the parent ContentFolder entity containing the requested subfolders.
The root virtual path is “\”.

PagedList<Content> GetFolderContent(string virtualPath, string marker, int pageSize)

Description
Retrieves the first level of files within the parent

ContentFolder

entity, which is specified using its virtual path. The

returned list is organized by File Name and may not contain more items than the defined page size. This method only
supports retrieval of image, audio, and video file types.

Required Permissions
Content: View Content

Parameters

[string] virtualPath: The virtual path of the parent ContentFolder entity. The root virtual path is “\”.

[string] marker: The [string] FileName of the last

Content

instance on the previous page. If the value

is Null, then the method will retrieve the first page.

[int] pageSize: The maximum number of objects returned by the method. If the list of objects that match the
search criteria exceeds the

[int] pageSize limit, the returned list will indicate that it is truncated. If the integer is

not positive, then the method will return the maximum allowed number of objects. Attempting to request more
objects than is allowed will lead to the same result, but without an error.

List<Content> GetSpecifiedContent(int[] contentIds)

Description
Retrieves a list of

Content

instances matching the specified identifiers. The results are sorted alphabetically by Content

[string] FileName. The identifiers of nonexistent Content instances will be ignored.

Required Permissions
Content: View Content

Advertising