Section
A section is a grouping of video shows in the VOD module.
Properties
- id (integer)
- name (string): Name of the section
- cssName (string): A name with no special characters that can be used as a styling enumerator.
- visibility (integer): 1 for visible sections, 0 for hidden sections
- url (string): URL for the section (used for web frontends and mobile app deep-linking), format: /section/ID-slug
Additional properties
In some cases, additional properties are available:
- latestEpisode (Video object): the latest episode of the show. This property is only returned in case such episode exists.
When the parameters (videos=1) is passed to some requests, you can get an expanded version of the Section with:
- shows (Array of Show object): visible shows inside this section
- videos (Array of Video object): all videos inside this section
Sample API Response
{"id":"2","name":"Longform shows","cssName":"longform","visibility":"1","url":"\/section\/2\/longform-shows","latestEpisode":{"id":"14","title":"Demo Video","url":"\/watch\/14\/demo-video","duration":"69","number":null,"status":"available","showId":"5","showName":"The Late Night Show","showUrl":"http:\/\/demo.local\/show\/5\/the-late-night-show","brief":"<p>Demo video description goes here<\/p>","thumbnail":"https:\/\/demo.local\/storage\/videos\/thumb_14_20558331340.jpeg","thumbnailPlay":"https:\/\/demo.local\/storage\/videos\/thumb_14_20558331340_play.jpeg","filename":"\/mnt\/c\/Users\/rudyz\/Sites\/whitebeardcms\/deployments\/demo\/storage\/videos\/Demo-Video_873041.mp4","publishDate":"2021-03-31 12:29:00","views":"0","publish":"0","formats":[{"format":"1080p","filename":"https:\/\/demo.local\/storage\/videos\/14_71433360761_1080p.mp4","cdnPath":"","mime":"video\/mp4"},{"format":"720p","filename":"https:\/\/demo.local\/storage\/videos\/14_71433360761_720p.mp4","cdnPath":"","mime":"video\/mp4"},{"format":"360p","filename":"https:\/\/demo.local\/storage\/videos\/14_71433360761_360p.mp4","cdnPath":"","mime":"video\/mp4"},{"format":"480p","filename":"https:\/\/demo.local\/storage\/videos\/14_71433360761_480p.mp4","cdnPath":"","mime":"video\/mp4"}]},"videos":[{"id":"14","title":"Demo Video","url":"\/watch\/14\/demo-video","duration":"69","number":null,"status":"available","showId":"5","showName":"The Late Night Show","showUrl":"http:\/\/demo.local\/show\/5\/the-late-night-show","brief":"<p>Demo video description goes here<\/p>","thumbnail":"https:\/\/demo.local\/storage\/videos\/thumb_14_20558331340.jpeg","thumbnailPlay":"https:\/\/demo.local\/storage\/videos\/thumb_14_20558331340_play.jpeg","filename":"\/mnt\/c\/Users\/rudyz\/Sites\/whitebeardcms\/deployments\/demo\/storage\/videos\/Demo-Video_873041.mp4","publishDate":"2021-03-31 12:29:00","views":"0","publish":"0","formats":[{"format":"1080p","filename":"https:\/\/demo.local\/storage\/videos\/14_71433360761_1080p.mp4","cdnPath":"","mime":"video\/mp4"},{"format":"720p","filename":"https:\/\/demo.local\/storage\/videos\/14_71433360761_720p.mp4","cdnPath":"","mime":"video\/mp4"},{"format":"360p","filename":"https:\/\/demo.local\/storage\/videos\/14_71433360761_360p.mp4","cdnPath":"","mime":"video\/mp4"},{"format":"480p","filename":"https:\/\/demo.local\/storage\/videos\/14_71433360761_480p.mp4","cdnPath":"","mime":"video\/mp4"}]}]}