BrightSign Network Web API Reference Manual v.3.8 User Manual

Page 47

Advertising
background image

35

Parameters

[string] marker: The [string] Name of the last AudioDynamicPlaylist 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<DynamicPlaylist> GetSpecifiedDynamicPlaylists(int[] dynamicPlaylistIds)

Description
Retrieves a list of

ImageVideoDynamicPlaylist

and/or

AudioDynamicPlaylist

instances matching the specified

identifiers. Instances are sorted alphabetically by

[string] Name. The identifiers of nonexistent instances will be

ignored.

Required Permissions
Dynamic Playlist: View Dynamic Playlists

Parameters

[int[]] dynamicPlaylistIds: An array of [int] Id values for the instances being requested. The
maximum number of items is limited to 100 by the server. Attempting to request more than the maximum allowed
number of objects will cause an error, while passing an empty array will lead to an immediate empty response
without an error.

PagedList<DynamicPlaylist> FindDynamicPlaylists(string namePattern, string marker, int
pageSize)

Description
Retrieves the next page of a Dynamic Playlist list containing names matched with the specified pattern. The returned
list is organized alphabetically by

[string] Name and may not contain more items than the defined page size. This

Advertising