...
The WebPage entity has the following properties:
[int] Id:(read only) The identifier and primary key of the WebPage instance.[string] Name: The user-defined name of the WebPage instance. This alternate key must be unique in the scope of the BrightSign Network account.[string] PhysicalPath:(read only) The external URL of the HTML file in persistent storage.[long] FileSize:(read only) The size of the associated HTML file in bytes.[string] FileHash:(read only) A SHA1 hash of the associated HTML file content.[DateTime] UploadDate:(read only) A UTC timestamp indicating when the Web Page was uploaded to the BrightSign Network.[WebPageAsset[]] Assets: A list of WebPageAsset entity-relations that reference Content instances that are in use by the WebPage entity. The list is set to Null when not initialized by the server.[PresentationInfo[]] Presentations:(read only) An array of PresentationInfo structures denoting presentations that are currently utilizing the WebPage instance.
...
The PresentationContent entity-relation represents the association between a Presentation instance and a Content instance. It has the following properties:
[int] ContentId:(read only) The identifier and primary key of the associated Content instance.[string] FileName: The virtual name of the file represented by the current Content instance.[int] PresentationId:(read only) The identifier and primary key of the associated Presentation instance.[string] PresentationName:(read only) The user-defined name of the associated Presentation instance.[string] StateName: The name of the presentation state that corresponds to the associated Content instance.[TimeSpan] DisplayDuration: The amount of time that the device displays an associated image.[string] ContentTransition: The screen effect that is shown during the transition between the previous presentation state and the current content state (i.e. the associated content state).
...
Retrieves the next page of the WebPage list, sorted by [string] Name. The returned list will contain no more items than the defined page size.
...
Web Page: View Web Pages
Parameters
[string] marker: The[string] Nameof 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] pageSizelimit 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.
...
Retrieves a list of WebPage instances matching the specified identifiers, sorted by [string] Name. The identifiers of nonexistent WebPage instances will be ignored.
...
Web Page: View WebPages
Parameters
[int[]] webPageIds: An array of[int] Idvalues values for the WebPage instances being requested. The number of returned 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.
...
Retrieves the next page of a WebPage list containing names matched with the specified pattern. The returned list is organized by [string] Name and and may not contain more items than the defined page size.
...
Web Page: View Web Pages
Parameters
[string] namePattern: The exact[string] Nameof of the WebPage instance (or its wildcard-based pattern). Supported wildcards currently include “*”, “?”, and “[‘and’]”.[string] marker: The[string] Nameof 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] pageSizelimit 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.
...
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.
...
Web Page: View Web Pages
Parameters
[int] webPageId: The identifier and primary key of the WebPage instance to be retrieved.[bool] loadAssets: A flag specifying whether the method should also initialize and return a list of all assets currently being used by the Web Page.
...
Retrieves the WebPage instance with the specified [string] Name. This method returns Null if the WebPage instance with the specified name does not exist.
...
Web Page: View Web Pages
Parameters
[string] name: The user-defined Name of the WebPage instance to be retrieved. The length of the string is limited to 50 characters.[bool] loadAssets: A flag specifying whether the method should also initialize and return a list of all assets currently being used by the Web Page.
...
Determines whether the specified WebPage entity [string] Name is is currently in use. This method returns True if a Web Page with the specified name currently exists.
...
Required Permissions
None
Parameters
[string] name: The Web Page Name value to be evaluated.
...
Note that when using this method to check whether a WebPage instance can be deleted, a False status may change in the time between calling this method and calling DeleteWebPages().
Required Permissions
Web Page: View Web Pages
Parameters
[int] webPageId: The identifier and primary key of the WebPage instance to evaluate. If a WebPage instance with the specified[int] Iddoes does not exist, this method will return False without an error.
...
Note that when using this method to check whether a WebPage instance can be deleted, a False status may change in the time between calling this method and calling DeleteWebPages().
Required Permissions
Web Page: View Web Pages
Parameters
[string] name: The user-defined name of the WebPage instance to evaluate. If a WebPage instance with the specified[string] Namedoes does not exist, this method will return False without an error.
bool RenameWebPage(int webPageId, string newName)
Updates the [string] Name of of the specified WebPage instance. This method returns True upon success and False upon failure.
...
Web Page: Update Web Page, Rename Web Page
Parameters
[int] webPageId: The identifier and primary key of the WebPage instance. If a WebPage instance with the specified identifier does not exist, the method will return False without an error.[string] newName: A new Name parameter for the specified WebPage instance. A descriptive error will be returned if the new Name string is greater than 50 characters.
...
Web Page: Delete Web Page
Parameters
[int[]] webPageIds: An array of[int] Idvalues values for the WebPage instances to be deleted. The 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. Passing Web Page identifiers that don’t exist will also result in an error return. Passing an empty array will lead to an immediate empty response without an error.
...