BrightSign Network Web API Reference Manual v.3.8 User Manual

Page 84

Advertising
background image

72

Parameters

[int[]] deviceWebPageIds: An array of [int] Id values for the DeviceWebPage instances being
requested. The number of items is limited on the server side. 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<WebPage> FindDeviceWebPages(string namePattern, int marker, int pageSize)

Description
Retrieves the next page of a

DeviceWebPage

list containing names matched with the specified pattern. The returned

list is organized by

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

Required Permissions
None

Parameters

[string] namePattern: The exact [string] Name of the DeviceWebPage instance (or its wildcard-based
pattern). Supported wildcards currently include “*”, “?”, and “[‘and’]”.

[int] marker: The [int] Id of the last DeviceWebPage instance on the previous page. If the integer is not
positive, 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.

DeviceWebPage GetDeviceWebPage(int webPageId, bool loadAssets)

Description
Retrieves a single

DeviceWebPage

instance with the specified

[int] Id. This method returns Null if the Device

WebPage instance with the specified identifier does not exist.

Advertising