POST Playlist/GetPlaylistOverview

Gets playlists for playlistoverview

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PageSize	Number of playlists per request	integer	None.
PageNum	Page number	integer	None.
UserID		integer	None.
Type	if type = 0 then gets playlist created by user and followed if type = 1 then gets playlist created by other people and not followed	integer	None.
Search	If empty all will be returned	string	None.

Request Formats

application/json, text/json

Sample:

{
  "PageSize": 1,
  "PageNum": 2,
  "UserID": 3,
  "Type": 4,
  "Search": "sample string 5"
}

text/html

Sample:

{"PageSize":1,"PageNum":2,"UserID":3,"Type":4,"Search":"sample string 5"}

application/xml, text/xml

Sample:

<RequestPlaylistOverview xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YogaStreamAPIv2">
  <PageNum>2</PageNum>
  <PageSize>1</PageSize>
  <Search>sample string 5</Search>
  <Type>4</Type>
  <UserID>3</UserID>
</RequestPlaylistOverview>

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

Response Information

Resource Description

Collection of PlaylistOverviewData

Name	Description	Type	Additional information
PlaylistID		integer	None.
PlaylistName		string	None.
PlaylistDescription		string	None.
UserID		integer	None.
UserFullname		string	None.
VideoCount		integer	None.
VideoDuration		integer	None.
VideoImage		string	None.
VideoID		integer	None.
PlaylistFollowed	1 for followed by user, 0 for not	integer	None.
PlaylistType		integer	None.
LogDate		string	None.
LogID		integer	None.
PlaylistViews	Views from playlist	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "PlaylistID": 1,
    "PlaylistName": "sample string 2",
    "PlaylistDescription": "sample string 3",
    "UserID": 4,
    "UserFullname": "sample string 5",
    "VideoCount": 6,
    "VideoDuration": 7,
    "VideoImage": "sample string 8",
    "VideoID": 9,
    "PlaylistFollowed": 10,
    "PlaylistType": 11,
    "LogDate": "sample string 12",
    "LogID": 13,
    "PlaylistViews": 14
  },
  {
    "PlaylistID": 1,
    "PlaylistName": "sample string 2",
    "PlaylistDescription": "sample string 3",
    "UserID": 4,
    "UserFullname": "sample string 5",
    "VideoCount": 6,
    "VideoDuration": 7,
    "VideoImage": "sample string 8",
    "VideoID": 9,
    "PlaylistFollowed": 10,
    "PlaylistType": 11,
    "LogDate": "sample string 12",
    "LogID": 13,
    "PlaylistViews": 14
  }
]

text/html

Sample:

[{"PlaylistID":1,"PlaylistName":"sample string 2","PlaylistDescription":"sample string 3","UserID":4,"UserFullname":"sample string 5","VideoCount":6,"VideoDuration":7,"VideoImage":"sample string 8","VideoID":9,"PlaylistFollowed":10,"PlaylistType":11,"LogDate":"sample string 12","LogID":13,"PlaylistViews":14},{"PlaylistID":1,"PlaylistName":"sample string 2","PlaylistDescription":"sample string 3","UserID":4,"UserFullname":"sample string 5","VideoCount":6,"VideoDuration":7,"VideoImage":"sample string 8","VideoID":9,"PlaylistFollowed":10,"PlaylistType":11,"LogDate":"sample string 12","LogID":13,"PlaylistViews":14}]

application/xml, text/xml

Sample:

<ArrayOfPlaylistOverviewData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YogaStreamAPIv2">
  <PlaylistOverviewData>
    <LogDate>sample string 12</LogDate>
    <LogID>13</LogID>
    <PlaylistDescription>sample string 3</PlaylistDescription>
    <PlaylistFollowed>10</PlaylistFollowed>
    <PlaylistID>1</PlaylistID>
    <PlaylistName>sample string 2</PlaylistName>
    <PlaylistType>11</PlaylistType>
    <PlaylistViews>14</PlaylistViews>
    <UserFullname>sample string 5</UserFullname>
    <UserID>4</UserID>
    <VideoCount>6</VideoCount>
    <VideoDuration>7</VideoDuration>
    <VideoID>9</VideoID>
    <VideoImage>sample string 8</VideoImage>
  </PlaylistOverviewData>
  <PlaylistOverviewData>
    <LogDate>sample string 12</LogDate>
    <LogID>13</LogID>
    <PlaylistDescription>sample string 3</PlaylistDescription>
    <PlaylistFollowed>10</PlaylistFollowed>
    <PlaylistID>1</PlaylistID>
    <PlaylistName>sample string 2</PlaylistName>
    <PlaylistType>11</PlaylistType>
    <PlaylistViews>14</PlaylistViews>
    <UserFullname>sample string 5</UserFullname>
    <UserID>4</UserID>
    <VideoCount>6</VideoCount>
    <VideoDuration>7</VideoDuration>
    <VideoID>9</VideoID>
    <VideoImage>sample string 8</VideoImage>
  </PlaylistOverviewData>
</ArrayOfPlaylistOverviewData>