Page Comparison

...

• [int] totalItemCount: The total number of presentations on the network that are visible to the user (i.e. viewing permissions may affect this number).
• [int] matchingItemCount: The total number of presentations on the network that match the filter criteria specified in the request.
• [int] pageSize: The maximum number of Presentation instances that can be returned in a single response
• [bool] isTruncated: A flag indicating whether the totalItemCount exceeds the pageSize
• [string] nextMarker: A value that can be included with a subsequent GET call to return additional results that have been truncated
• [string] sortExpression:  The sort expression specified in the URL
• [string] filterExpression: The filter expression specified in the URL
• [Presentation[]] items: An array of Presentation object instances. Each Presentation instance can have the following entries:
  • [int] id: A unique identifier for the Presentation instance. This value is generated by the server when the presentation is created.
  • [string] name: The presentation name

  • [string] type:  The presentation type, which can be either "Simple" or "Complete" (see the endpoint overview above for more details). 

    Anchor
    type type

  • [string] status: The authoring status of the Presentation entity. A "Draft" value indicates that the presentation is incomplete, lacking the autoplay-[PresentationName].xml or resources.txt file. A "Published" value indicates that the presentation has the necessary files to be published. This entry is applicable to complete presentations only.
  • [PresentationFile[]] files: An array of PresentationFile object instances. This entry is applicable to complete presentations only. Each PresentationFile object instance can have the following values:
    • [int] id: A unique identifier for the file. This value is generated by the server when the file is uploaded.
    • [string] name: The filename
    • [string] path: The file URI on the server
    • [string] type: The file type, which can be "Media", "Stored" (i.e. non-media), or "Folder".
    • [int] size: The file size (in bytes)
    • [string] hash: The hash algorithm and value. The string is formatted as "{algorithm}:{value}" (e.g. "SHA1:6DB465879088280AAC52DC22B07ED0AD493A99D4").
    • [string] creationDate: A UTC timestamp indicating when the file was created. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.
    • [string] lastModifiedDate: A UTC timestamp indicating when the file was last modified. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.
  • [PresentationFile] autoplayFile: A PresentationFile object instance representing the autoplay XML file, which contains information related to presentation playback: states, zones, playlist data, etc. This entry is applicable to complete presentations only.
  • [PresentationFile] projectFile: A PresentationFile object instance representing the project file. This entry is applicable to complete presentations only.
  • [PresentationFile] resourcesFile: A PresentationFile object instance representing the resources file. This entry is applicable to complete presentations only.
  • [PresentationFile] userDefinedEventsFile: A PresentationFile object instance representing the user-defined events file. This entry is applicable to complete presentations only.
  • [string] creationDate: A UTC timestamp indicating when the presentation was created on BSN. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.
  • [string] lastModifiedDate: A UTC timestamp indicating when the presentation was last modified on BSN. The date/time is formatted as yyyy-mm-ddThh:mm:ss.sssZ.
  • [string] autorunVersion: The version of autorun used to create the presentation. If the presentation was created via BSN APIs (i.e. a simple presentation), the autorun version is determined by the current standard autorun used by BSN.  If the presentation was created on a client application and uploaded (i.e. a complete presentation), the autorun version is determined by the autorunVersion value specified with the POST/PUT request.
  • [string] deviceModel: The target BrightSign player model for the presentation
  • [string] language: The target language of the presentation. This property currently has no effect on the operation of a presentation. The following are valid return values: "Unknown", "English", "French", "Italian", "German", "Spanish", "Swedish"
  • [ScreenSettings] screenSettings: An array of values indicating the screen settings of the presentation. This entry can also be Null for player models that do not support video output (i.e. the LS322).
    • [string] videoMode: A video mode supported by the player model
    • [string] connector: A video output supported by the player model, which can be either "HDMI", "VGA", or "Component"
    • [string] orientation: The orientation of the presentation canvas, which can be either "Portrait" or "Landscape"
    • [string] backgroundColor: The background color of the presentation canvas. The color value is represented by the string “RGB: {R:XX}{G:XX}{B:XX)”, where “XX” is equivalent to a two-digit hexadecimal number (e.g. “RGB:4787C7”).
    • [string] overscan: The overscan display setting, which can be either "overscan", "overscanActionSafeArea", or "overscanTitleSafeArea"
  • [Group[]] groups: An array of Group object instances representing groups to which the presentation belongs. Each Group instance can have the following values:
    • [int] id: A unique identifier for the group
    • [string] name: The group name
  • [Autorun[]] autorunPlugins: An array of Autorun object instances representing plugins attached to the presentation
  • [Permission[]] permissions: An array of Permission object instances representing permissions rules assigned to the presentation

...