POST UserCalendar/Read

Get users calendar items

Request Information

URI Parameters

None.

Body Parameters

RequestUserCalendarRead
NameDescriptionTypeAdditional information
UserID

integer

None.

Month

How many months back from todays date should be included - 0 gets all items

integer

None.

Year

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "UserID": 1,
  "Month": 2,
  "Year": 3
}

text/html

Sample:
{"UserID":1,"Month":2,"Year":3}

application/xml, text/xml

Sample:
<RequestUserCalendarRead xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YogaStreamAPIv2">
  <Month>2</Month>
  <UserID>1</UserID>
  <Year>3</Year>
</RequestUserCalendarRead>

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

Response Information

Resource Description

Collection of UserCalendarHolder
NameDescriptionTypeAdditional information
Date

string

None.

CalendarPosts

Collection of UserCalendar

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].CalendarPosts[0].VideoData.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].CalendarPosts[0].VideoData.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].CalendarPosts[0].VideoData.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.