Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: updated format

All live text feed entities are structured as follows:

entity:

[

Id int

] Id

: The unique identifier for the live text feed instance

[

Name string

] Name

: The name of the live text feed instance

[

PhysicalPath string

] PhysicalPath

The location of the live text feed XML file in the server directory

[

FileSize long

] FileSize

The size of the live text feed XML file (in bytes)

[

FileHash string

] FileHash

The hash value of the live text feed file. The string is formatted as "{algorithm}:{value}" (e.g. "SHA1:6DB465879088280AAC52DC22B07ED0AD493A99D4").

[

CreationDate DateTime

] CreationDate

A timestamp indicating when the live text feed was created on BSN.cloud. See DateTime for more information about this data type.

[

LastModifiedDate DateTime

] LastModifiedDate

: A timestamp indicating when the live text feed was last modified on BSN.cloud. See DateTime

 for

 for more information about this data type.

[

Items LiveTextFeedItem[

]

]

 Items

[

Title string

] Title

The key (RSS item title) of the item in the associated live text feed

[

Description string

] Description

The value (RSS item description) of the item in the associated live text feed

[

ValidityStartDate Nullable<DateTime>

] ValidityStartDate

The validity start date for the entry (that is, the point at which it will start being included in the live text feed). A null value specifies that the item is valid immediately when added to the live text feed. See DateTime for more information about this data type.

[

ValidityEndDate Nullable<DateTime>

] ValidityEndDate

The validity end date for the associated entry (that is, the point at which it will no longer be included in the live text feed).  A null value specifies that the item will be valid until it is removed from the live text feed manually by a user. See DateTime for more information about this data type.

[

Presentations PresentationInfo[

]

]

 Presentations

An array of Presentation Info entities for each presentation associated with the live text feed instance

[

Permissions List<Permission>

] Permissions

: A list of permission object instances representing permissions rules assigned to the live text feeds instance