BrightSign Network Web API Reference Manual v.3.8 - Manual (Page 114)

102
Parameters
•
[int] groupID: The identifier of the Group instance that is associated with the schedule. If a Group instance
with the specified identifier does not exist, the method will immediately return Null without an error.
• [string] marker: The [string] ExpirationDate of the last ScheduledPresentation 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.
ScheduledPresentation AddScheduledPresentation(int groupId, ScheduledPresentation entity)
Description
Schedules a
Presentation instance for the specified Group instance and updates related service files in the storage. If
successful, this method will return the newly created ScheduledPresentation entity-relation. This method will return
Null if an error occurs.
Required Parameters
Schedule: Update Schedule, Add Presentation – Presentation: Assign Presentation
Parameters
•
[int] groupId: The identifier of the Group instance for which the Presentation instance should be scheduled.
• [ScheduledPresentation] entity: A ScheduledPresentation object instance with a Presentation [int] Id
and/or Presentation
[string] Name. A Group [int] Id and/or Group [string] Name is also required. If this
parameter is set to Null, then this method will immediately return Null without an error. A descriptive error will be
returned if any of the following conditions occur:
o The specified Presentation [int] Id or Presentation [string] Name does not correspond to an existing
Presentation instance.