POST Videos/Courses

Get course(s)

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PageSize	Number of courses per request	integer	None.
PageNum	Page number	integer	None.
CourseID	Use 0 for all courses. When > 0 filter values will be ignored.	integer	None.
UserID	User ID	integer	None.
FilterPregnant	1 gets pregnant videos	integer	None.
FilterBeginner	1 gets beginner videos	integer	None.
FilterInstructor	IDs from Videos/Instructors	Collection of integer	None.
FilterTheme	IDs from Videos/AllFilters	Collection of integer	None.
FilterType	0 = All, 1 = Challenges only, 2 = Standard courses only	integer	None.
YearMonth	Format yyyymm - ie. 202010 \| if present then it gets challenges in that month - must include userid	string	None.

Request Formats

application/json, text/json

Sample:

{
  "PageSize": 1,
  "PageNum": 2,
  "CourseID": 3,
  "UserID": 4,
  "FilterPregnant": 5,
  "FilterBeginner": 6,
  "FilterInstructor": [
    1,
    2
  ],
  "FilterTheme": [
    1,
    2
  ],
  "FilterType": 7,
  "YearMonth": "sample string 8"
}

text/html

Sample:

{"PageSize":1,"PageNum":2,"CourseID":3,"UserID":4,"FilterPregnant":5,"FilterBeginner":6,"FilterInstructor":[1,2],"FilterTheme":[1,2],"FilterType":7,"YearMonth":"sample string 8"}

application/xml, text/xml

Sample:

<RequestVideoCourses xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YogaStreamAPIv2">
  <CourseID>3</CourseID>
  <FilterBeginner>6</FilterBeginner>
  <FilterInstructor xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </FilterInstructor>
  <FilterPregnant>5</FilterPregnant>
  <FilterTheme xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </FilterTheme>
  <FilterType>7</FilterType>
  <PageNum>2</PageNum>
  <PageSize>1</PageSize>
  <UserID>4</UserID>
  <YearMonth>sample string 8</YearMonth>
</RequestVideoCourses>

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 'RequestVideoCourses'.

Response Information

Resource Description

Collection of CourseData

Name	Description	Type	Additional information
Course_ID		integer	None.
Course_Type	0 = normal, 1 = challenge	integer	None.
Course_Watched		boolean	None.
Course_Challenge		boolean	None.
Course_ChallengeDays		integer	None.
Course_VideoCount		integer	None.
Course_Name		string	None.
Course_URI		string	None.
Course_AvailableForUser		boolean	None.
Course_Thumbnail		string	None.
Course_Description		string	None.
Course_Duration		integer	None.
Course_DateCreated		string	None.
Course_Beginner		boolean	None.
Course_Pregnant		boolean	None.
Course_FilterIDs		Collection of integer	None.
Course_AddedToCalendar		boolean	None.
Course_AddedToCalendarDateTime		string	None.
Course_Filters		Collection of VideoFiltersParent	None.
UserCourseData		UserCourseData	None.
InstructorUser_ID		integer	None.
InstructorUser_FirstName		string	None.
InstructorUser_LastName		string	None.
InstructorUser_Image		string	None.
InstructorUser_Description		string	None.
InstructorUser_AfterName		string	None.
InstructorUser_Quote		string	None.
Course_Videos		Collection of CourseDataVideo	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 with type 'YogaStreamAPIv2.VideoData'. Path '[0].Course_Videos[0].AllData.Course.Videos'.

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 with type 'YogaStreamAPIv2.VideoData'. Path '[0].Course_Videos[0].AllData.Course.Videos'.

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 with type 'YogaStreamAPIv2.VideoData'. Path '[0].Course_Videos[0].AllData.Course.Videos'.

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.