POST Videos/SetWatched
Set User/Video watched
Request Information
URI Parameters
None.
Body Parameters
RequestVideosSetWatched| Name | Description | Type | Additional information |
|---|---|---|---|
| UserID | integer |
None. |
|
| VideoID | integer |
None. |
|
| PlaylistID |
If PlaylistID > 0 only logs one time |
integer |
None. |
| CalendarLogID |
DEPRECATED!!!! - Can be 0 - Used to update the Calendar/Read output to check whether or not the Calendar video has been watched |
integer |
None. |
| SecondsWatched | integer |
None. |
|
| FastForwarded | boolean |
None. |
|
| LiveVideo | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"UserID": 1,
"VideoID": 2,
"PlaylistID": 3,
"CalendarLogID": 4,
"SecondsWatched": 5,
"FastForwarded": true,
"LiveVideo": 7
}
text/html
Sample:
{"UserID":1,"VideoID":2,"PlaylistID":3,"CalendarLogID":4,"SecondsWatched":5,"FastForwarded":true,"LiveVideo":7}
application/xml, text/xml
Sample:
<RequestVideosSetWatched xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YogaStreamAPIv2"> <CalendarLogID>4</CalendarLogID> <FastForwarded>true</FastForwarded> <LiveVideo>7</LiveVideo> <PlaylistID>3</PlaylistID> <SecondsWatched>5</SecondsWatched> <UserID>1</UserID> <VideoID>2</VideoID> </RequestVideosSetWatched>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
Success| Name | Description | Type | Additional information |
|---|---|---|---|
| success | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"success": true
}
text/html
Sample:
{"success":true}
application/xml, text/xml
Sample:
<Success xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YogaStreamAPIv2"> <success>true</success> </Success>