POST Videos/Videos

Get video(s)

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PageSize	Number of videos per request	integer	None.
PageNum	Page number	integer	None.
UserID	Use 0 for not logged in.	integer	None.
VideoID	Use 0 for all videos. When > 0 filter values will be ignored.	integer	None.
FilterInstructor	IDs from Videos/Instructors	Collection of integer	None.
FilterDuration	1 = 7min \| 2 = 15min \| 3 = 20min \| 4 = 30min \| 5 = 45min \| 6 = 60min \| 7 = 90min	Collection of integer	None.
FilterLanguage	IDs from Videos/AllFilters	Collection of integer	None.
FilterStyle	IDs from Videos/AllFilters	Collection of integer	None.
FilterLevel	IDs from Videos/AllFilters	Collection of integer	None.
FilterTheme	IDs from Videos/AllFilters	Collection of integer	None.
FilterBodyPart	IDs from Videos/AllFilters	Collection of integer	None.
FilterText	Freetext search	string	None.
IsLive	0 no live videos or 1 = get live videos	integer	None.
YearMonth	Format yyyymm - ie. 202010 \| if present then it gets videos in that month - must include userid	string	None.

Request Formats

application/json, text/json

Sample:

{
  "PageSize": 1,
  "PageNum": 2,
  "UserID": 3,
  "VideoID": 4,
  "FilterInstructor": [
    1,
    2
  ],
  "FilterDuration": [
    1,
    2
  ],
  "FilterLanguage": [
    1,
    2
  ],
  "FilterStyle": [
    1,
    2
  ],
  "FilterLevel": [
    1,
    2
  ],
  "FilterTheme": [
    1,
    2
  ],
  "FilterBodyPart": [
    1,
    2
  ],
  "FilterText": "sample string 5",
  "IsLive": 6,
  "YearMonth": "sample string 7"
}

text/html

Sample:

{"PageSize":1,"PageNum":2,"UserID":3,"VideoID":4,"FilterInstructor":[1,2],"FilterDuration":[1,2],"FilterLanguage":[1,2],"FilterStyle":[1,2],"FilterLevel":[1,2],"FilterTheme":[1,2],"FilterBodyPart":[1,2],"FilterText":"sample string 5","IsLive":6,"YearMonth":"sample string 7"}

application/xml, text/xml

Sample:

<RequestVideos xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YogaStreamAPIv2">
  <FilterBodyPart xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </FilterBodyPart>
  <FilterDuration xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </FilterDuration>
  <FilterInstructor xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </FilterInstructor>
  <FilterLanguage xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </FilterLanguage>
  <FilterLevel xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </FilterLevel>
  <FilterStyle xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </FilterStyle>
  <FilterText>sample string 5</FilterText>
  <FilterTheme xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </FilterTheme>
  <IsLive>6</IsLive>
  <PageNum>2</PageNum>
  <PageSize>1</PageSize>
  <UserID>3</UserID>
  <VideoID>4</VideoID>
  <YearMonth>sample string 7</YearMonth>
</RequestVideos>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RequestVideos'.

Response Information

Resource Description

VideoDataHolder

Name	Type	Additional information
NumberOfVideos	integer	None.
Course_ID	integer	None.
Course_Name	string	None.
Course_Description	string	None.
Course_Challenge	boolean	None.
Videos	Collection of VideoData	None.

Response Formats

application/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected for property 'Course' with type 'YogaStreamAPIv2.VideoDataHolder'. Path 'Videos[0]'.

text/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected for property 'Course' with type 'YogaStreamAPIv2.VideoDataHolder'. Path 'Videos[0]'.

text/html

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'text/html'. Exception message: Self referencing loop detected for property 'Course' with type 'YogaStreamAPIv2.VideoDataHolder'. Path 'Videos[0]'.

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'Newtonsoft.Json.Linq.JToken' is a recursive collection data contract which is not supported. Consider modifying the definition of collection 'Newtonsoft.Json.Linq.JToken' to remove references to itself.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'Newtonsoft.Json.Linq.JToken' is a recursive collection data contract which is not supported. Consider modifying the definition of collection 'Newtonsoft.Json.Linq.JToken' to remove references to itself.