POST api/VideoTracking/Progress

Action that handles the requests for the progress of an user on a certain video given the playUniqueSessionId that identifies a session Play in the LMS

Request Information

URI Parameters

None.

Body Parameters

The body of the request that contains the necessary parameters for fetching the Statements from the LRS

VideoRequestBody

Name	Type	Additional information
UserId	string	None.
CommunityId	string	None.
OrganizationId	string	None.
CurrentPlayUniqueSessionId	string	None.
VideoId	string	None.

Request Formats

application/json, text/json

Sample:

{
  "UserId": "sample string 1",
  "CommunityId": "sample string 2",
  "OrganizationId": "sample string 3",
  "CurrentPlayUniqueSessionId": "sample string 4",
  "VideoId": "sample string 5"
}

application/xml, text/xml

Sample:

<VideoRequestBody xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Adevico.xApi_LRC.Models">
  <CommunityId>sample string 2</CommunityId>
  <CurrentPlayUniqueSessionId>sample string 4</CurrentPlayUniqueSessionId>
  <OrganizationId>sample string 3</OrganizationId>
  <UserId>sample string 1</UserId>
  <VideoId>sample string 5</VideoId>
</VideoRequestBody>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

An object that rappresents the progress of an user on a certain video

VideoProgress

Name	Type	Additional information
VideoState	VideoState	None.
VideoDuration	time interval	None.
TotalWatchedPercentage	decimal number	None.
CurrentPlaySessionTotalWatchedPercentage	decimal number	None.
TotalWatchedSeconds	time interval	None.
CurrentPlaySessionWatchedSeconds	time interval	None.
TotalWatchTimeVectors	Collection of TimeVector	None.
CurrentPlaySessionWatchTimeVectors	Collection of TimeVector	None.
TotalTimeSpentOnVideoPage	time interval	None.
CurrentPlaySessionTimeSpentOnVideoPage	time interval	None.

Response Formats

application/json, text/json

Sample:

{
  "VideoState": 0,
  "VideoDuration": "00:00:00.1234567",
  "TotalWatchedPercentage": 2.1,
  "CurrentPlaySessionTotalWatchedPercentage": 3.1,
  "TotalWatchedSeconds": "00:00:00.1234567",
  "CurrentPlaySessionWatchedSeconds": "00:00:00.1234567",
  "TotalWatchTimeVectors": [
    {
      "UniquePlaySessionId": "sample string 1",
      "EndTime": "00:00:00.1234567",
      "StartTime": "00:00:00.1234567",
      "Duration": "00:00:00"
    },
    {
      "UniquePlaySessionId": "sample string 1",
      "EndTime": "00:00:00.1234567",
      "StartTime": "00:00:00.1234567",
      "Duration": "00:00:00"
    }
  ],
  "CurrentPlaySessionWatchTimeVectors": [
    {
      "UniquePlaySessionId": "sample string 1",
      "EndTime": "00:00:00.1234567",
      "StartTime": "00:00:00.1234567",
      "Duration": "00:00:00"
    },
    {
      "UniquePlaySessionId": "sample string 1",
      "EndTime": "00:00:00.1234567",
      "StartTime": "00:00:00.1234567",
      "Duration": "00:00:00"
    }
  ],
  "TotalTimeSpentOnVideoPage": "00:00:00.1234567",
  "CurrentPlaySessionTimeSpentOnVideoPage": "00:00:00.1234567"
}

application/xml, text/xml

Sample:

<VideoProgress xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Adevico.xApi_LRC.Models">
  <CurrentPlaySessionTimeSpentOnVideoPage>PT0.1234567S</CurrentPlaySessionTimeSpentOnVideoPage>
  <CurrentPlaySessionTotalWatchedPercentage>3.1</CurrentPlaySessionTotalWatchedPercentage>
  <CurrentPlaySessionWatchTimeVectors>
    <TimeVector>
      <EndTime>PT0.1234567S</EndTime>
      <StartTime>PT0.1234567S</StartTime>
      <UniquePlaySessionId>sample string 1</UniquePlaySessionId>
    </TimeVector>
    <TimeVector>
      <EndTime>PT0.1234567S</EndTime>
      <StartTime>PT0.1234567S</StartTime>
      <UniquePlaySessionId>sample string 1</UniquePlaySessionId>
    </TimeVector>
  </CurrentPlaySessionWatchTimeVectors>
  <CurrentPlaySessionWatchedSeconds>PT0.1234567S</CurrentPlaySessionWatchedSeconds>
  <TotalTimeSpentOnVideoPage>PT0.1234567S</TotalTimeSpentOnVideoPage>
  <TotalWatchTimeVectors>
    <TimeVector>
      <EndTime>PT0.1234567S</EndTime>
      <StartTime>PT0.1234567S</StartTime>
      <UniquePlaySessionId>sample string 1</UniquePlaySessionId>
    </TimeVector>
    <TimeVector>
      <EndTime>PT0.1234567S</EndTime>
      <StartTime>PT0.1234567S</StartTime>
      <UniquePlaySessionId>sample string 1</UniquePlaySessionId>
    </TimeVector>
  </TotalWatchTimeVectors>
  <TotalWatchedPercentage>2.1</TotalWatchedPercentage>
  <TotalWatchedSeconds>PT0.1234567S</TotalWatchedSeconds>
  <VideoDuration>PT0.1234567S</VideoDuration>
  <VideoState>NOT_STARTED</VideoState>
</VideoProgress>