BrightWall APIs

BrightWallGroupInfo Structure

The BrightWallGroupInfo structure provides basic key information about a BrightWallGroup instance. It has the following values:

• Id int:(read only) The identifier and primary key of the BrightWallGroup instance.

• Name string: (read only) The user-defined name of the BrightWallGroup instance. This alternate key is unique in the scope of the BSN account.

BrightWallPresentationInfo Structure

The BrightWallPresentationInfo structure provides basic key information about a BrightWallPresentation instance. It has the following values:

• Id int: (read only) The identifier and primary key of the BrightWallPresentation instance.

• Name string: (read only) The user-defined name of the BrightWallPresentation instance. This alternate key is unique in the scope of the BSN account.

FileInfo Structure

The FileInfo structure provides basic information about a file that is stored on the BrightSign Network. It has the following values:

• Name string: (read only) The virtual name of the file. This value may differ from the actual file name in persistent storage.

• Path string: (read only) An external URL for the file in persistent storage.

• Size long: (read only) The size of the associated file (in bytes).

• Hash string: (read only) The SHA1 hash of the associated file contents.

• CreationDate DateTime: (read only) A UTC timestamp indicating when the associated file was uploaded to (or created in) BSN.

• LastModifiedDate DateTime: (read only) A UTC timestamp indicating when the associated file was last modified.

BrightWallScreen Entity-Relation

The BrightWallScreen entity-relation represents associations between a BrightWall screen and Device/Content instances. It has the following values:

• Number byte: The 1-based sequence number of the current screen, as calculated by row from the top-left corner of the current BrightWall.

• Device Device: The Device instance associated with the current screen.

• Content Presentation Content[]: An array of PresentationContent entity-relations referencing Content instances in the current BrightWall presentation.

ScheduledBrightWallPresentation Entity-Relation

The ScheduledBrightWallPresentation entity-relation represents associations between BrightWallPresentation and BrightWallGroup instances. It has the following values:

• Id int: (read only) The identifier and primary key of a scheduled BrightWallPresentation instance.

• PresentationId int: The identifier of the BrightWallPresentation instance that is scheduled for the associated BrightWallGroup instance.

• PresentationName string: The name of the BrightWallPresentation instance that is scheduled for the associated BrightWallGroup instance.

• IsRecurrent bool: A flag specifying whether the related BrightWall presentation is played periodically at specified times and days of the week.

• EventDate Nullable<DateTime>: A DateTime value specifying the date when a non-recurrent BrightWall presentation should begin playing. A Null value can be set for recurrent presentations that do not have a defined start date.

• StartTime TimeSpan: A TimeSpan value specifying the time when a BrightWall presentation should begin playing.

• Duration TimeSpan: A TimeSpan value specifying how long a BrightWall presentation should play.

• RecurrenceStartDate Nullable<DateTime>: A DateTime value indicating the date when a recurrently scheduled presentation should begin playing. A Null value can be set for recurrent presentations that do not have a defined start date.

• RecurrenceEndDate Nullable<DateTime>: A DateTime value indicating the date when a recurrently scheduled BrightWall presentation should terminate. A Null value can be set for recurrent presentations that do not have a defined end date.

• DaysOfWeek DayOfWeek: A value indicating the days of the week during which a recurrently scheduled BrightWall presentation should play. A BrightWall presentation scheduled for “all day, every day” can be created with the following property settings: StartTime as “00:00:00”, EndTime as “1.00:00:00” (or “24:00:00”), and DaysofWeek as “EveryDay”; EventDate, RecurrenceStartDate, and RecurrenceEndDate are set to Null.

• CreationDate DateTime: (read only) A UTC timestamp indicating when the related BrightWall Presentation instance was scheduled for the associated BrightWall Group instance.

• LastModifiedDate DateTime: (read only) A UTC timestamp indicating when the current schedule was last updated.

• ExpirationDate DateTime: (read only) A UTC timestamp indicating when the current schedule will expire.

BrightWall Management Web Methods

PagedList<BrightWall> GetBrightWalls(int configurationId, string marker, int pageSize)

Retrieves the next page of the BrightWall list, sorted by string Name. The list contains all BrightWall instances associated with the specified BrightWallConfiguration instance. This method will return no more items than the defined page size.

Required Permissions

BrightWall: View BrightWalls

Parameters

• configurationId int: The primary identifier of the BrightWallConfiguration instance associated with the BrightWall groups, which in turn contain BrightWall instances.

• marker string: The string Name of the last BrightWall instance on the previous page. If the value is Null, the method will retrieve the first page.

• pageSize int: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds the pageSize int 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<BrightWall> GetSpecifiedBrightWalls(int[] brightWallIds)

Retrieves a list of BrightWall instances matching the specified identifiers, sorted by [string] Name. The identifiers of nonexistent BrightWall instances will be ignored.

Required Permissions

BrightWall: View BrightWalls

Parameters

• brightWallIds int[] : An array of Id  int values indicating the BrightWall instances to retrieve. The server limits the number of requested objects to 100. 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<BrightWall> FindBrightWalls(string namePattern, string marker, int pageSize)

Retrieves the next page of a BrightWall list containing file names matched with the specified pattern. The returned list is organized by Name string and may not contain more items than the defined page size.

Required Permissions

BrightWall: View BrightWalls

Parameters

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

• marker string: The Namestring of the last BrightWall instance on the previous page. If this value is Null, then the method will retrieve the first page.

• pageSize int: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds the pageSize int 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.

BrightWall GetBrightWall(int brightWallId, bool loadScreens)

Retrieves a single BrightWall instance with the specified Id int. This method returns Null if a BrightWall instance with the specified identifier does not exist.

Required Permissions

BrightWall: View BrightWall, View Devices – [Device: View Devices]

Parameters

• brightWallId int: The identifier and primary key of the BrightWall instance to be retrieved.

• loadScreens bool: A flag indicating whether the method should also initialize and return the screens that are part of the BrightWall.

BrightWall GetBrightWallByName(string name, bool loadScreens)

Retrieves the BrightWall instance with the specified string Name. This method returns Null if a BrightWall instance with the specified name does not exist.

Required Permissions

BrightWall: View BrightWall, View Devices – [Device: View Devices]*

*This permission is only required if the BrightWall instance contains one or more devices.

Parameters

• name string: The user-defined name of the BrightWall instance to be retrieved.

• loadScreens bool: A flag indicating whether the method should also initialize and return the screens that are part of the BrightWall.

bool CheckBrightWallName(string name)

Determines whether the specified Name string is currently being used by a BrightWall instance. This method returns True if a BrightWall instance with the specified name currently exists.

Required Permissions

None

Parameters

• name string: The BrightWall name value to be evaluated.

BrightWall CreateBrightWall(BrightWall entity)

Creates a new BrightWall instance using the values of the passed BrightWall entity. If successful, this method returns the created object with all initialized properties. If an error occurs during creation, the method will return Null.

Required Permissions

BrightWall: Create BrightWall, [Update BrightWall]*, [Add Device]** – BrightWall Group: Add BrightWall – [Group: Remove Device]* – [Device: Change Target Groups]*

*These permissions are only required when reassigning devices from other BrightWall, BrightWallGroup, or Group instances.

**This permission is only required when adding devices to the new BrightWall instance during the creation process.

Parameters

• entity BrightWall: A BrightWall object instance with initialized BrightWallGroupId int, Name string, and Screens BrightWallScreen[] values. All other properties will be ignored during object creation. If this parameter is set to Null, then the method will immediately return Null without an error. A descriptive error will be returned if any of the following conditions occur:

  • The BrightWall group with the specified identifier does not exist.

  • The length of the specified Name string exceeds 50 characters.

  • The specified Name string is already in use by another BrightWall instance.

  • The number of BrightWallScreen entity-relations does not match the number of screens specified in the BrightWallConfiguration instance associated with the BrightWall group.

  • The specified Number byte values of the BrightWallScreen entity-relations do not start from 1 or are not sequential within the array.

  • The Id int or Serial string value of a Device instance (specified using the Device Device values of the BrightWallScreen entity-relations) references a nonexistent device.

  • More than one BrightWallScreen entity-relation specifies the same Device instance.

bool UpdateBrightWall(BrightWall entity)

Updates the specified BrightWall instance using the values passed in the BrightWall entity. This method returns True only if completely successful; otherwise, it will return False.

Required Permissions

BrightWall: Update BrightWall, [Add Device]*, [Remove Device]* – [BrightWall Group: Add BrightWall, Remove BrightWall]* – [Group: Remove Device]* – [Device: Change Target Group]*

*These permissions are only required when moving devices to/from other BrightWall, BrightWallGroup, or Group instances.

Parameters

• entity BrightWall: A BrightWall object instance specifying the Id int of the BrightWall instance to update, as well as the new BrightWallGroupId int and Screens [BrightWallScreen[]] values to use for the updated instance. If this parameter is Null or Invalid, the method will immediately return Null without an error. A descriptive error will be returned if any of the following conditions occur.

  • The specifiedId int does not correspond to an existing BrightWall instance.

  • A BrightWallGroup instance with the specified Id int does not exist.

  • The number of BrightWallScreen entity-relations does not match the number of screens specified in the BrightWallConfiguration instance associated with the new BrightWall group.

  • The specified Number byte values of the BrightWallScreen entity-relations do not start from 1 or are not sequential within the array.

  • The Id int or Serial string value of a Device instance (specified with the Device Device values of the BrightWallScreen entity-relations) references a nonexistent device.

  • More than one BrightWallScreen entity-relation specifies the same Device instance.

bool ReassignBrightWalls(int[] brightWallIds, int newGroupId)

Reassigns the specified BrightWall instance(s) to the specified BrightWallGroup instance. This operation returns True only if it is completely successful; otherwise, it returns False.

Required Permissions

BrightWall: Change BrightWall Group – BrightWall Group: Remove BrightWall, Add BrightWall

Parameters

• brightWallIds int[]: An array of one or more Id int values corresponding to the BrightWall instance(s) that should be reassigned. The number of objects is limited to 100 by the server; attempting to reassign more than the allowed number of objects will result in an error. Passing an array containing an Id int value that does not correspond to an existing BrightWall instance will also result in an error, while passing an empty array will lead to an immediate False response without an error.

• newGroupId int: The identifier of the target BrightWallGroup instance to which the BrightWall instances should be reassigned. A descriptive error will be returned if any of the following conditions occur:

  • The specified Id int does not correspond to an existing BrightWallGroup instance.

  • The BrightWallGroup instance is associated with a different BrightWall configuration than one or more of the BrightWall instances being reassigned.

bool DeleteBrightWall(int brightWallId, int reassignmentGroupId)

Deletes the specified BrightWall instance(s) and reassigns the devices associated with them. This method returns True only if completely successful; otherwise, it returns False.

Required Permissions

BrightWall: Delete BrightWall, [Remove Device]* – [Group: Add Device]* – [Device: Change Target Group]*

*These permissions are only required when removing devices from the BrightWall instance during the deletion process.

Parameters

• brightWallIds int[]: An array of Id int values specifying the BrightWall instances that should be deleted. The number of objects is limited to 100 by the server; attempting to delete more than the allowed number of objects will result in an error. Passing an array containing an [int] Id value that does not correspond to an existing BrightWall instance will also result in an error, while passing an empty array will lead to an immediate False response without an error.

• reassignmentGroupId int: The Id int of the Group instance to which the Device instances should be reassigned. If this value is negative, the devices will be reassigned to the "Unassigned" Group instance. If the specified Id int does not correspond to an existing BrightWallGroup instance, the method will return a descriptive error.

BrightWall Configuration Management Web Methods

PagedList<BrightWallConfiguration> GetBrightWallConfigurations(string marker, int pageSize)

Retrieves the next page of the BrightWallConfiguration list, sorted by Name string. This method will return no more items than the defined page size.

Required Permissions

None

Parameters

• marker string: The Name string of the last BrightWallConfiguration instance on the previous page. If the value is Null, the method will retrieve the first page.

• pageSize int: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds the pageSize int 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.

BrightWallConfiguration GetBrightWallConfiguration(int configurationId)

Retrieves a single BrightWallConfiguration instance with the specified Id int. This method returns Null if a BrightWallConfiguration instance with the specified identifier does not exist.

Required Permissions

None

Parameters

• configurationId int: The identifier and primary key of the configuration instance to be retrieved.

BrightWallConfiguration GetBrightWallConfigurationByName(string name)

Retrieves the BrightWallConfiguration instance with the specified [string] Name. This method returns Null if a BrightWallConfiguration instance with the specified name does not exist.

Required Permissions

None

Parameters

• name string: The user-defined name of the BrightWallConfiguration instance to be retrieved.

bool CheckBrightWallConfigurationName(string name)

Determines whether the specified Name string is currently being used by a BrightWallConfiguration instance. This method returns True if a BrightWallConfiguration instance with the specified name currently exists.

Required Permissions

None

Parameters

• name string: The BrightWallConfiguration name value to be evaluated.

bool CheckBrightWallConfigurationUsage(int configurationId)

Determines whether the specified BrightWallConfiguration instance (specified by its primary key) is referenced by one or more BrightWall groups and/or BrightWall presentations (i.e. whether it has parent dependencies). This method returns True if the instance is in use; otherwise, it will return False.

This method is auxiliary: It cannot be used to reliably determine if a BrightWallConfiguration instance can be deleted because the state of an instance can change between this call and a DeleteBrightWallConfigurations() call.

Required Permissions

None

Parameters

• configurationId int: The identifier and primary key of the configuration instance to be evaluated. If the BrightWallConfiguration instance with the specified identifier does not exist, the method will return False without error.

bool CheckBrightWallConfigurationUsageByName(string name)

Determines whether the specified BrightWallConfiguration instance (specified by its Name string) is referenced by one or more BrightWall groups and/or BrightWall presentations (i.e. whether it has parent dependencies). This method returns True if the instance is in use; otherwise, it will return False.

This method is auxiliary: It cannot be used to reliably determine if a BrightWallConfiguration instance can be deleted because the state of an instance can change between this call and a DeleteBrightWallConfigurations() call.

Required Permissions

None

Parameters

• name string: The user-defined name of the BrightWallConfiguration instance to be evaluated. If the BrightWallConfiguration instance with the specified name does not exist, the method will return false without error.

BrightWallConfiguration CreateBrightWallConfiguration(BrightWallConfiguration entity)

Creates a new BrightWallConfiguration instance using the values of the passed BrightWallConfiguration entity. If successful, this method returns the created object with all initialized properties. If an error occurs during creation, the method will return Null.

Required Permissions

None

Parameters

• entity BrightWallConfiguration: A BrightWallConfiguration object instance with all initialized values, excluding the following (which will be ignored during object creation): Id int, CreationDate DateTime, BrightWallGroups BrightWallGroupInfo[], BrightWallPresentations BrightWallPresentationInfo[]. If this parameter is set to Null, the method will immediately return Null without error. A descriptive error will be returned to the client if any of the following conditions occur:

  • The Name string of the BrightWallConfiguration instance is not specified.

  • The length of the specified Name string exceeds 50 characters.

  • The specified Name string is already in use by another BrightWallConfiguration instance.

  • The specified RowsCount byte or ColumnsCount byte is not positive.

  • The total number of screens (determined by multiplying RowsCount byte by ColumnsCount byte) is greater than 100.

  • The DeviceModel DeviceModel is not specified (or set to Unknown).

  • The specified DeviceModel DeviceModel is specified as one of the following: HD210, HD1010, TD1012, AU320, or LS322. These models do not support BrightWall presentations.

  • The specified DeviceModel DeviceModel does not support the specified VideoModeVideoMode on the specified VideoConnector ConnectorType.

  • The specified BezelWidth short or BezelHeight short is less than 0 or greater than 100 when the BezelUnits MeasureUnit is specified as Percentage.

  • The specified ScreenWidth short or ScreenHeight short is not a positive value when the BezelUnits MeasureUnit is specified as Millimeter.

  • The specified BezelHeight short is less than 0 or greater than the ScreenHeight short value when BezelUnits MeasureUnit is specified as Millimeter.

  • The specified BezelWidth short is less than 0 or greater than the ScreenWidth short value when BezelUnits MeasureUnit is specified as Millimeter.

  • The specified PTPDomain byte is less than 0 or greater than 127.

bool UpdateBrightWallConfiguration(BrightWallConfiguration entity)

Updates the specified BrightWallConfiguration using the values passed in the BrightWallConfiguration entity. This method returns True only if completely successful; otherwise, it will return False.

Required Permissions

BrightWall Presentation: Update BrightWall Presentation

Parameters

• entity BrightWallConfiguration: A BrightWallConfiguration object instance containing the Id int of the instance to update, as well as other initialized values. The following values will be ignored during the update process: DateTime, CreationDate, BrightWallGroups, BrightWallPresentations. If any of the applicable parameters are Null or Invalid, the method will immediately return False without an error. A descriptive error will be returned to the client if any of the following conditions occur:

  • The specified Id int does not correspond to an existing BrightWallConfiguration instance.

  • The specified Name  string of the BrightWallConfiguration instance is not specified.

  • The length for the specified Name  string exceeds 50 characters.

  • The specified Name string is already in use by another BrightWallConfiguration instance.

  • The specified RowsCount byte or ColumnsCount byte does not equal the original value.

  • The specified DeviceModel DeviceModel does not equal the original value. This only applies if the BrightWallConfiguration instance has one or more dependent BrightWall presentations.

  • The specified DeviceModel  DeviceModel does not support the specified VideoMode VideoMode on the VideoConnector ConnectorType.

  • The specified BezelWidth short or BezelHeight  short is less than 0 or greater than 100 when the BezelUnits MeasureUnit is specified as Percentage.

  • The specified ScreenWidth short or ScreenHeight short  is not a positive value when the BezelUnits MeasureUnit is specified as Millimeter.

  • The specified BezelHeight  short is less than 0 or greater than the ScreenHeight short value when BezelUnits MeasureUnit is specified as Millimeter.

  • The specified BezelWidth  short is less than 0 or greater than the ScreenWidth short value when BezelUnits MeasureUnit is specified as Millimeter.

  • The specified PTPDomain byte is less than 0 or greater than 127.

bool DeleteBrightWallConfigurations(int[] configurationIds)

Deletes the specified BrightWallConfiguration instance(s) from the database. This method returns True only if completely successful; otherwise, it will return False.

Required Permissions

None

Parameters

• configurationIds int[]: An array of one or more [int] Id values corresponding to the BrightWallConfiguration instance(s) that should be deleted. The server limits the number of requested objects to 100. 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. An error will also be returned to the client if one or more Id int values do not correspond to an existing BrightWall instance. A descriptive error will be returned if the following condition occurs:

  • The specified BrightWallConfiguration file is currently being used by one or more BrightWall groups or BrightWall presentations.

BrightWallGroup Management Web Methods

PagedList<BrightWallGroup> GetAllBrightWallGroups(string marker, int pageSize)

Retrieves the next page of the BrightWallGroup list, sorted by Name string. This method will return no more items than the defined page size.

Required Permissions

BrightWall Groups: View BrightWall Groups

Parameters

• marker string: The Name string of the last BrightWallGroup instance on the previous page. If the value is Null, the method will retrieve the first page.

• pageSize int: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds the pageSize int 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.

PagedList<BrightWallGroup> GetBrightWallGroups(int configurationId, string marker, int pageSize)

Retrieves the next page of the BrightWallGroup list, sorted by Name string. The list contains all BrightWallGroup instances associated with the specified BrightWallConfiguration instance. This method will return no more items than the defined page size.

Required Permissions

BrightWall Group: View BrightWall Groups

Parameters

• configurationId int: The primary identifier of the BrightWallConfiguration instance associated with the requested BrightWallGroup instances.

• marker string: The Name string of the last BrightWallGroup instance on the previous page. If the value is Null, the method will retrieve the first page.

• pageSize int: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds the pageSize int 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<BrightWallGroup> GetSpecifiedBrightWallGroups(int[] groupIds)

Retrieves a list of BrightWallGroup instances matching the specified identifiers, sorted by Name string. The identifiers of nonexistent BrightWallGroup instances will be ignored.

Required Permissions

BrightWall Group: View BrightWall Groups

Parameters

• groupIds int[]: An array of Id int values indicating the BrightWallGroup instances to retrieve. The server limits the number of requested objects to 100. 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<BrightWallGroup> FindBrightWallGroups(string namePattern, string marker, int pageSize)

Retrieves the next page of a BrightWallGroup list containing file names matched with the specified pattern. The returned list is organized by Name string and may not contain more items than the defined page size.

Required Permissions

BrightWall Groups: View BrightWall Groups

Parameters

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

• marker string: The Name string of the last BrightWallGroup instance on the previous page. If this value is Null, then the method will retrieve the first page.

• pageSize int: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds the pageSize int 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.

BrightWallGroup GetBrightWallGroup(int groupId, bool loadBrightWalls)

Retrieves a single BrightWallGroup instance with the specified Id int. This method returns Null if a BrightWallGroup instance with the specified identifier does not exist.

Required Permissions

BrightWall Group: View BrightWall Groups, [View Devices]* – [Device: View Devices]*

*These permissions are only required if the specified BrightWallGroup instance contains devices.

Parameters

• groupId int: The identifier and primary key of the BrightWallGroup instance to be retrieved.

• loadBrightWalls bool: A flag indicating whether the method should also initialize and return the BrightWall instances that are part of the BrightWall group.

BrightWallGroup GetBrightWallGroupByName(string name, bool loadBrightWalls)

Retrieves the BrightWallGroup instance with the specified Name string. This method returns Null if a BrightWall instance with the specified name does not exist.

Required Permissions

BrightWall Group: View BrightWall Groups, [View Devices]* – [Device: View Devices]*

*These permissions are only required if the specified BrightWallGroup instance contains devices.

Parameters

• name string: The user-defined name of the BrightWallGroup instance to be retrieved.

• loadBrightWallGroupByName bool: A flag indicating whether the method should also initialize and return BrightWall instances that are part of the BrightWall group.

BrightWallGroup CreateBrightWallGroup(BrightWallGroup entity)

Creates a new BrightWallGroup instance using the values of the passed BrightWallGroup entity. If successful, this method returns the created object with all initialized properties. If an error occurs during creation, the method will return Null.

Required Permissions

BrightWall: Create BrightWall Group

Parameters

• entity BrightWallGroup: A BrightWallGroup object instance with all initialized values, excluding the following (which will be ignored during object creation): Id int, CreationDate DateTime, AutorunVersion string, BrightWallsCountushort, DevicesCount int, DevicesHealthStatus DeviceHealthStatus, BrightWalls BrightWall[], and Presentations BrightWallPresentationInfo[]. If this parameter is set to Null, then the method will immediately return Null without an error. A descriptive error will be returned if any of the following conditions occur:

  • The BrightWallConfiguration instance with the specified identifier does not exist.

  • The length of the specified Name string exceeds 50 characters.

  • The specified Name string is already in use by another BrightWallGroup instance.

  • The sum of the PublishedDataSizeLimit ushort, DynamicDataSizeLimit ushort, HtmlDataSizeLimit ushort, and HtmlLocalStorageSizeLimit ushort values does not equal 100 when the StorageSpaceLimitUnits enumeration is set to Percentage.

  • One of the specified model firmware versions is invalid or not supported.

bool UpdateBrightWallGroup(BrightWallGroup entity)

Updates the specified BrightWallGroup instance using the values passed in the BrightWallGroup entity. This method returns True only if completely successful; otherwise, it will return False.

Required Permissions

BrightWall Group: Update BrightWall Group

Parameters

• entity BrightWallGroup: A BrightWallGroup object instance specifying the Id int of the BrightWallGroup instance to update, as well as other new properties for the updated instance: HD9XXFirmware string, HDX20Firmware string, HDX22Firmware string, XDX30Firmware string, XDX32Firmware string, 4KX42Firmware string, EnableSerialDebugging bool, EnableSystemLogDebugging bool, StorageSpaceLimitUnits StorageSpaceLimitUnit, PublishedDataSizeLimit ushort, DynamicDataSizeLimit ushort, HtmlDataSizeLimit ushort, and HtmlLocalStorageSizeLimit ushort. If this parameter is Null or Invalid, the method will immediately return Null without an error. A descriptive error will be returned if any of the following conditions occur.

  • The specified Id int does not correspond to an existing BrightWallGroup instance.

  • The Name string of the BrightWallGroup entity does not correspond to the original instance (i.e. BrightWallGroup instances cannot be renamed using this method).

  • The sum of the PublishedDataSizeLimit ushort, DynamicDataSizeLimit ushort,  HtmlDataSizeLimit ushort,  and HtmlLocalStorageSizeLimit ushort values does not equal 100 when the StorageSpaceLimitUnits enumeration is set to Percentage.

  • One of the specified model firmware versions is invalid or not supported.

bool UpdateBrightWallGroupsFirmware(int[] groupIds, string hdx20Firmware, string hdx22Firmware, string xdx30Firmware, string xdx32Firmware, string 4kx42Firmware)

Updates the target firmware for players in the specified BrightWallGroup instance(s). This method returns True upon success and False upon failure.

Required Permissions

BrightWall Group: Update BrightWall Group, Update Firmware

Parameters

• groupIds int[]: An array of one or more Id  int values indicating BrightWallGroup instance(s) to be updated. 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.

• hdx20Firmware string: A new value for the HDX20Firmware property of the specified BrightWallGroup instance(s).

• hdx22Firmware string: A new value for the HDX22Firmware property of the specified BrightWallGroup instance(s).

• xdx30Firmware string: A new value for the XDX30Firmware property of the specified BrightWallGroup instance(s).

• xdx32Firmware string: A new value for the XDX32Firmware property of the specified BrightWallGroup instance(s).

• 4kx42Firmware string: A new value for the 4KX42Firmware property of the specified BrightWallGroup instance(s).

bool DeleteBrightWallGroup(int groupId, int reassignmentGroupId)

Deletes the specified BrightWallGroup instance(s) from the database. This method returns True only if completely successful; otherwise, it will return False.

Required Permissions

BrightWall Group: Delete BrightWall Group – [BrightWall: Delete BrightWall]*, [Remove Device]** –  [Group: Add Device]** – [Device: Change Target Group]**

*This permission is only required if the specified BrightWallGroup instance contains one or more BrightWall instance.

**These permissions are only required if a BrightWall instance within the BrightWallGroup instance contains one or more devices.

Parameters

• groupIds int[]: An array of one or more Id int values corresponding to the BrightWallGroup instance(s) that should be deleted. The server limits the number of requested objects to 100. 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. An error will also be returned to the client if one or more Id  int values do not correspond to an existing BrightWallGroup instance.

• reassignmentGroupId int: The Id  int of the Group instance to which the Device instances should be reassigned. If this value is negative, the devices will be reassigned to the "Unassigned" Group instance. If the specified Id  int does not correspond to an existing BrightWallGroup instance, the method will return a descriptive error.

BrightWallPresentation Management Web Methods

PagedList<BrightWallPresentation> GetAllBrightWallPresentations(string marker, int pageSize)

Retrieves the next page of the BrightWallPresentation list, sorted by Name string. This method will return no more items than the defined page size.

Required Permissions

BrightWall Presentation: View BrightWall Presentations

Parameters

• marker string: The Name string of the last BrightWallPresentation instance on the previous page. If the value is Null, the method will retrieve the first page.

• pageSize int: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds the pageSize int 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.

PagedList<BrightWallPresentation> GetBrightWallPresentations(int configurationId, string marker, int pageSize)

Retrieves the next page of the BrightWallPresentation list, sorted by Name string. The list contains all BrightWallPresentation instances associated with the specified BrightWallConfiguration instance. This method will return no more items than the defined page size.

Required Permissions

BrightWall Presentation: View BrightWall Presentations

Parameters

• configurationId int: The primary identifier of the BrightWallConfiguration instance associated with the requested BrightWallPresentation instances.

• marker string: The Name string of the last BrightWallPresentation instance on the previous page. If the value is Null, the method will retrieve the first page.

• pageSize int: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds the pageSize int 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<BrightWallPresentation> GetSpecifiedBrightWallPresentations(int[] brightWallPresentationIds)

Retrieves a list of BrightWallPresentation instances matching the specified identifiers, sorted by Name string. The identifiers of nonexistent BrightWallGroup instances will be ignored.

Required Permissions

BrightWall Presentation: View BrightWall Presentations

Parameters

• brightWallPresentationIds int[]: An array of Id int values indicating the BrightWallPresentation instances to retrieve. The server limits the number of requested objects to 100. 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<BrightWallPresentation> FindBrightWallPresentations(string namePattern, string marker, int pageSize)

Retrieves the next page of a BrightWallPresentation list containing file names matched with the specified pattern. The returned list is organized by Name string and may not contain more items than the defined page size.

Required Permissions

BrightWall Presentation: View BrightWall Presentations

Parameters

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

• marker string: The Name  string of the last BrightWallPresentation instance on the previous page. If this value is Null, then the method will retrieve the first page.

• pageSize int: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds the pageSize int 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.

BrightWallPresentation GetBrightWallPresentation(int brightWallPresentationId, bool loadScreens)

Retrieves a single BrightWallPresentation instance with the specified Id int. This method returns Null if a BrightWallPresentation instance with the specified identifier does not exist.

Required Permissions

BrightWall Presentation: View BrightWall Presentation, View Contents – [Content: View Content]*

*This permission is only required if the specified BrightWallPresentation instance contains one or more Content instances.

Parameters

• brightWallPresentationId int: The identifier and primary key of the BrightWallPresentation instance to be retrieved.

• loadScreens bool: A flag indicating whether the method should also initialize and return BrightWallScreen entity-relations instances that are part of the BrightWall presentation.

BrightWallPresentation GetBrightWallPresentationByName(string name, bool loadScreens)

Retrieves the BrightWallPresentation instance with the specified Name string. This method returns Null if a BrightWall instance with the specified name does not exist.

Required Permissions

BrightWall Presentation: View BrightWall Presentation, View Contents – [Content: View Content]*

*This permission is only required if the specified BrightWallPresentation instance contains one or more Content instances.

Parameters

• name string: The user-defined name of the BrightWallPresentation instance to be retrieved.

• loadScreens bool: A flag indicating whether the method should also initialize and return BrightWallScreen entity-relations instances that are part of the BrightWall presentation.

bool CheckBrightWallPresentationName(string name)

Determines whether the specified Name string is currently in use by a BrightWallPresentation instance. This method returns True if a BrightWallPresentation instance with the specified name currently exists.

Required Permissions

None

Parameters

• name string: The BrightWallPresentation Name string to be evaluated.

bool CheckBrightWallPresentationUsage(int brightWallPresentationId)

Determines whether the specified BrightWallPresentation instance (specified by its primary key) is referenced by one or more BrightWall groups (i.e. whether it has parent dependencies). This method returns True if the instance is in use; otherwise, it will return False.

This method is auxiliary: It cannot be used to reliably determine if a BrightWallPresentation instance can be deleted because the state of an instance can change between this call and a DeleteBrightWallPresentations() call.

Required Permissions

BrightWall Presentation: View BrightWall Presentations

Parameters

• BrightWallPresentationId int: The identifier and primary key of the BrightWallPresentation instance to be evaluated. If the BrightWallPresentation instance with the specified identifier does not exist, the method will return False without error.

bool CheckBrightWallPresentationUsageByName(string name)

Determines whether the specified BrightWallPresentation instance (specified by its Name string) is referenced by one or more BrightWall groups (i.e. whether it has parent dependencies). This method returns True if the instance is in use; otherwise, it will return False.

This method is auxiliary: It cannot be used to reliably determine if a BrightWallPresentation instance can be deleted because the state of an instance can change between this call and a DeleteBrightWallPresentations() call.

Required Permissions

BrightWall Presentation: View BrightWall Presentations

Parameters

• name string: The user-defined name of the BrightWallPresentation instance to be evaluated. If the BrightWallPresentation instance with the specified name does not exist, the method will return false without error.

BrightWallPresentation CreateBrightWallPresentation(BrightWallPresentation entity)

Creates a new BrightWallPresentation instance (and related internal files) using the properties in the passed BrightWallPresentation entity. If successful, the method returns the instance with all initialized properties. If an error occurs during the initialization process, the method will return Null.

Required Permissions

BrightWall Presentation: Create BrightWall Presentation – [Content: Assign Content]*

*This permission is only required if Content instances will be assigned to the BrightWallPresentation instance during the creation process.

Parameters

• entity BrightWallPresentation: A BrightWallPresentation object instance with all initialized values, excluding the following (which will be ignored during object creation): Id int, CreationDate DateTime, LastModifiedDate DateTime, ProjectFile FileInfo, and Groups BrightWallGroupInfo[] (note that the AutorunVersion string value is optional). If this parameter is set to Null, then the method will immediately return Null without an error. A descriptive error will be returned if any of the following conditions occur:

  • The BrightWallConfiguration instance with the specified identifier does not exist.

  • The length of the specified Name  string exceeds 50 characters.

  • The specified Name  string is already in use by another BrightWallPresentation instance.

  • The specified AnalogOutput1 AnalogOutputMode, HDMIOutput HDMIOutputMode, or SPDIFOutput SPDIFOutputMode parameter is not supported by one or more players in the BrightWall (i.e. in the BrightWallScreen entity-relations associated with the entity).

  • The number of BrightWallScreen entity-relations does not match the amount specified by the BrightWall configuration file associated with the presentation.

  • The specified AutorunVersion string is invalid or not supported.

  • The ContentId int of one or more PresentationContent entity-relations (which are referenced by the passed BrightWallScreen entity-relations) does not match an existing Content instance.

  • One or more PresentationContent entity-relations have an unsupported ContentType. BrightWall presentations currently only support the following content types: Video, VideoStream, LiveVideo, and RadioInput.

  • The ContentType ContentType of a PresentationContent entity-relation does not correspond to the Type ContentType of the corresponding Content entity.

  • Different BrightWallScreen entity-relations reference different PresentationContent entity-relations when the IsRegular bool property is set to False (i.e. the presentation is set to "Stretched"). All screens in a "Stretched" BrightWall presentation must play the same content.

  • The Name string of a PresentationContent entity-relation exceeds 128 characters.

  • TheStateName string of a PresentationContent entity-relation exceeds 128 characters.

  • The StateName string of a PresentationContent entity-relation is not unique in the scope of a BrightWallScreen entity-relation.

bool UpdateBrightWallPresentation(BrightWallPresentation entity)

Updates the specified BrightWallPresentation instance using the values passed in the BrightWallGroup entity. This method returns True only if completely successful; otherwise, it will return False.

Required Permissions

BrightWall Presentation: Update BrightWall Presentation – [Content: Assign Content, Unassign Content]*

*These permissions are only required if Content instances will be added to or removed from the BrightWallPresentation instance during the update process.

Parameters

• entity BrightWallPresentation: A BrightWallPresentation object instance specifying the Id int of the BrightWallPresentation instance to update. This object instance should include all initialized values, excluding the following: CreationDate DateTime, LastModifiedDateDateTime, ProjectFile FileInfo, and Groups BrightWallGroupInfo[] (note that the AutorunVersion string value is optional). If this parameter is Null or Invalid, the method will immediately return Null without an error. A descriptive error will be returned if any of the following conditions occur:

  • The specified Id int does not correspond to an existing BrightWallPresentation instance.

  • The specified BrightWallConfiguration entity does not have the same RowsCount byte, ColumnsCount byte, or DeviceModel DeviceModel as the configuration file originally associated with the BrightWallPresentation instance.

  • The specified AnalogOutput1 AnalogOutputMode, HDMIOutput HDMIOutputMode, or SPDIFOutput SPDIFOutputMode parameter is not supported by one or more of the players in the BrightWall (i.e.in the BrightWallScreen entity-relations associated with the entity).

  • The number of BrightWallScreen entity-relations does not match the amount specified by the BrightWall configuration file associated with the presentation.

  • The ContentType ContentType of a PresentationContent entity-relation does not correspond to the Type ContentTypeof the corresponding Content entity.

  • The ContentId int of one or more PresentationContent entity-relations (which are referenced by the passed BrightWallScreen entity-relations) does not match an existing Content instance.

  • One or more PresentationContent entity-relations have an unsupported ContentType. BrightWall presentations currently only support the following content types: Video, VideoStream, LiveVideo, and RadioInput.

  • Different BrightWallScreen entity-relations reference different PresentationContent entity-relations when the IsRegular bool property is set to False (i.e. the presentation is set to "Stretched"). All screens in a "Stretched" BrightWall presentation must play the same content.

  • The StateName  string of a PresentationContent entity-relation exceeds 128 characters.

  • The StateName  string of a PresentationContent entity-relation is not unique in the scope of a BrightWallScreen entity-relation.

bool DeleteBrightWallPresentations(int[] brightWallPresentationIds)

Deletes the specified BrightWallPresentation instance(s) from the database. This method returns True only if completely successful; otherwise, it will return False.

Required Permissions

BrightWall Presentation: Delete BrightWall Presentation

Parameters

• brightWallPresentationIds int[]: An array of one or more Id int values corresponding to the BrightWallPresentation instance(s) that should be deleted. The server limits the number of requested objects to 100. 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. An error will also be returned to the client if one or more Id int values do not correspond to an existing BrightWallPresentation instance. A descriptive error will be returned if a BrightWallPresentation instance is scheduled for one or more BrightWall groups.