...
The data types below, which are consistent across all APIs, are used in the BSN.cloud Main API
...
as are the entities in the child pages beneath this page.
DateTime
Defines a moment in time using a sortable UTC pattern value format, based
...
on rfc3339. An example would be 2022-02-18T16:57:00.123Z
DayOfWeek
Represents the day of the week from Sunday to Saturday.
...
The days are specified as a string list (for example, "Monday, Wednesday, Friday").
| Panel | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
ON THIS PAGE
|
FileInfo (and Derived Structures)
FileInfo is primarily related to the Presentation entity but is used in limited way by other entities as well. The FileInfo collection may contain the elements below in JSON representation. See Mapping Media Type References for more information about using this data type.
NewFile
NewFile ('FileInfo.Type' property set to "New") is derived from the abstract 'FileInfo' structure, and is used to upload small files and for complete presentation creation or updates. See the example below (your values will vary for all but "type"):
| Code Block |
|---|
{
"type": "New", // [string], structure data type visible only in JSON representation and used by de-serializer to determine expected property set of this object instance
"name": "hello.txt", // [string]
"size": 12, // [uint]
"hash": "", // [string]
"creationDate": null, // [DateTime]
"lastModifiedDate": null, // [DateTime]
"body": "SGVsbG8gV29ybGQh", // [string]
"transferEncoding": "BASE64" // one of { "None", "BASE64" } enumeration values
} |
RemoteFile
RemoteFile ('FileInfo.Type' property set to "Remote") is derived from the abstract 'FileInfo' structure, and is used to reference remote resources or even files uploaded to BSN by URL. See the example below (your values will vary for all but "type"):
| Code Block |
|---|
{
"type": "Remote", // [string], structure data type visible only in JSON representation and used by de-serializer to determine expected property set of this object instance
"name": "autoplugins.brs", // [string]
"size": 222, // [uint]
"hash": "SHA1:EC121A89DFEE4E62AA94FAC4B9D80F13EA6B0FD6", // [string]
"creationDate": null, // [DateTime]
"lastModifiedDate": null, // [DateTime]
"path": "https://bsn-staging.s3.amazonaws.com/Content/Autoplugins/autoplugins-EC121A89DFEE4E62AA94FAC4B9D80F13EA6B0FD6.brs" // one of { "None", "BASE64" } enumeration values
} |
StoredFile
StoredFile ('FileInfo.Type' property set to "Stored") is derived from the abstract 'FileInfo' structure, and is used to reference any file uploaded to BSN by ID. See the example below (your values will vary for all but "type"):
| Code Block |
|---|
{
"type": "Stored", // [string], structure data type visible only in JSON representation and used by de-serializer to determine expected property set of this object instance
"name": "autoplugins.brs", // [string]
"size": 222, // [uint]
"hash": "SHA1:EC121A89DFEE4E62AA94FAC4B9D80F13EA6B0FD6", // [string]
"creationDate": null, // [DateTime]
"lastModifiedDate": null, // [DateTime]
"id": 9804728, // [int]
"path": "https://bsn-staging.s3.amazonaws.com/Content/Autoplugins/autoplugins-EC121A89DFEE4E62AA94FAC4B9D80F13EA6B0FD6.brs" // [URI]
} |
MediaFile
MediaFile('FileInfo.Type' property set to "Media") derived from the 'StoredFile' structure, and is used to reference uploaded files visible in the BSN Content Library by ID. See the example below (your values will vary for all but "type"):
| Code Block |
|---|
{
"type": "Media", // [string], structure data type visible only in JSON representation and used by de-serializer to determine expected property set of this object instance
"name": "Odessa Rain.jpg", // [string]
"size": 226675, // [uint]
"hash": "SHA1:4B55491958FC06E904D78BF2C965B47629FC5D16", // [string]
"creationDate": "2017-05-22T16:20:26.430Z", // [DateTime]
"lastModifiedDate": "2016-09-20T09:39:42.253Z", // [DateTime]
"id": 64947, // [int]
"mediaType": "Image", // one of { "Text", "Image", "Video", "Audio" } enumeration values
"path": "http://localhost:8081/Content/Images/782e4c7d-f5a1-4b21-bd76-3706fff20063.jpg" // [URI]
} |
DynamicPlaylistFile
DynamicPlaylistFlle ('FileInfo.Type' property set to "DynamicPlaylist") is derived from the 'StoredFile' structure, and is used to reference dynamic playlists existing in BSN by ID. See the example below (your values will vary for all but "type"):
| Code Block |
|---|
{
"type": "DynamicPlaylist", // [string], structure data type visible only in JSON representation and used by de-serializer to determine expected property set of this object instance
"name": "My First Dynamic Playlist", // [string]
"size": 912, // [uint]
"hash": "SHA1:E7BA1A1668AB68E6A0090A0A950D43A25A316D8E", // [string]
"creationDate": "2017-01-15T23:46:46.287Z", // [DateTime]
"lastModifiedDate": "2018-01-11T10:17:17.960Z", // [DateTime]
"id": 31711, // [int]
"path": "http://localhost:8081/Content/DynamicPlaylists/My First Dynamic Playlist.xml" // [URI]
} |
TaggedPlaylistFile
TaggedPlaylistFile ('FileInfo.Type' property set to "TaggedPlaylist") is derived from the 'StoredFile' structure, and is used to reference tagged playlists existing in BSN by ID. See the example below (your values will vary for all but "type"):
| Code Block |
|---|
{
"type": "TaggedPlaylist", // [string], structure data type visible only in JSON representation and used by de-serializer to determine expected property set of this object instance
"name": "My First Tagged Playlist", // [string]
"size": 0, // [uint]
"hash": "SHA1:E7BA1A1668AB68E6A0090A0A950D43A25A316D8E", // [string]
"creationDate": "2017-02-08T00:00:55.273Z", // [DateTime]
"lastModifiedDate": "2017-02-08T00:00:55.273Z", // [DateTime]
"id": 47323, // [int]
"path": "http://localhost:8080/bs/GetFile.ashx?type=TaggedPlaylist&token=7E2DBC0CC21E2449D06CA32836AD86BB" // [URI]
} |
LiveTextFeedFile
LiveTextFeedFile ('FileInfo.Type' property set to "LiveTextFeed") is derived from the 'StoredFile' structure, and is used to reference live text feeds existing in BSN by ID. See the example below (your values will vary for all but "type"):
| Code Block |
|---|
{
"type": "LiveTextFeed", // [string], structure data type visible only in JSON representation and used by de-serializer to determine expected property set of this object instance
"name": "My First Live Text Feed", // [string]
"size": 912, // [uint]
"hash": "SHA1:2C95B879DD75A398CB37AAA7851F3ACBC5CE7419", // [string]
"creationDate": "2017-02-08T00:17:57.573Z", // [DateTime]
"lastModifiedDate": "2018-01-09T23:39:02.123Z", // [DateTime]
"id": 47325, // [int]
"path": "http://localhost:8081/Content/Eugene/Feeds/My First Live Text Feed.xml" // [URI]
} |
LiveMediaFeedFile
LiveMediaFeedFile ('FileInfo.Type' property set to "LiveMediaFeed") is derived from the 'StoredFile' structure, and is used to reference live media feeds existing in BSN by ID. See the example below (your values will vary for all but "type"):
| Code Block |
|---|
{
"type": "LiveMediaFeed", // [string], structure data type visible only in JSON representation and used by de-serializer to determine expected property set of this object instance
"name": "My First Live Media Feed", // [string]
"size": 378, // [uint]
"hash": "SHA1:4DA06FEE7FDDA07511BC4A876CF79989D034550B", // [string]
"creationDate": "2017-02-08T00:17:38.130Z", // [DateTime]
"lastModifiedDate": "2017-06-08T11:32:41.280Z", // [DateTime]
"id": 47324, // [int]
"path": "http://localhost:8081/Content/LiveMediaFeeds/My First Live Media Feed.xml" // [URI]
} |
WebPageFile
WebPageFile ('FileInfo.Type' property set to "WebPage") is derived from the 'StoredFile' structure, and is used to reference (regular) webpages uploaded to BSN by ID. See the example below (your values will vary for all but "type"):
| Code Block |
|---|
{
"type": "WebPage", // [string], structure data type visible only in JSON representation and used by de-serializer to determine expected property set of this object instance
"name": "My First Web Page", // [string]
"size": 20224, // [uint]
"hash": "SHA1:1F224E31B9265062BE58E7D12FE3332E03536D48", // [string]
"creationDate": "2017-02-19T20:10:11.287Z", // [DateTime]
"lastModifiedDate": "2016-12-01T23:46:35.793Z", // [DateTime]
"id": 47487, // [int]
"path": "http://localhost:8081/Content/WebPages/9184f22b-51da-42e3-9900-c9c5bba03e6e.html" // [URI]
} |
Nullable<int>
...
Nullable<int>
Data types that are prefixed with "nullable" (for example, nullable<int>) accept null value. Most data types are not nullable in this API framework, so this data type allows you to accept null for a non-nullable type. By default, nullable types are strings, objects, and arrays.
TimeSpan
Represents a period of time. Possible values are:
00:00 - 23:59 (hours and minutes)
00:00:00 - 23:59:59 (hours, minutes, and seconds. This is the default format)
00:00:00.000 - 23:59:59.999 (hours, minutes, seconds, and milliseconds)
1.00:00:00 - 99999.23:59:59 (date, hours, minutes, seconds)
1.00:00:00.000 - 99999.23:59:59.999 (date, hours, minutes, seconds, and milliseconds)
Uri
A representation of a resource available on the internet or intranet. This data type is nullable.