BrightSign Network Web API Reference Manual v.3.8 User Manual

Page 77

Advertising
background image

65

PagedList<WebPage> FindWebPages(string namePattern, string marker, int pageSize)

Description
Retrieves the next page of a

WebPage

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
Web Page: View Web Pages

Parameters

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

[string] marker: The [string] Name of the last WebPage 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.

WebPage GetWebPage(int webPageId, bool loadAssets)

Description
Retrieves a single

WebPage

instance with the specified

[int] Id. This method returns Null if the WebPage instance

with the specified identifier does not exist.

Required Permissions
Web Page: View Web Pages

Parameters

[int] webPageId: The identifier and primary key of the WebPage instance to be retrieved.

Advertising