POST api/StorylineTracking/SlideProgress

Handles the requests for computation of the Progress of a Storyline of type SLIDE

Request Information

URI Parameters

None.

Body Parameters

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

Name	Type	Additional information
UserId	string	None.
CommunityId	string	None.
OrganizationId	string	None.
CurrentPlayUniqueSessionId	string	None.
StorylineId	string	None.
StorylineGuid	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",
  "StorylineId": "sample string 5",
  "StorylineGuid": "sample string 6"
}

application/xml, text/xml

Sample:

<StorylineRequestBody 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>
  <StorylineGuid>sample string 6</StorylineGuid>
  <StorylineId>sample string 5</StorylineId>
  <UserId>sample string 1</UserId>
</StorylineRequestBody>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The Progress done by the specified user on the specified Storyline

StorylineSlidesProgress

Name	Type	Additional information
StorylineState	StorylineState	None.
TotalTimeStay	time interval	None.
CurrentPlaySessionTimeStay	time interval	None.
TotalViewedSlidesCount	integer	None.
CurrentPlaySessionViewedSlidesCount	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "StorylineState": 0,
  "TotalTimeStay": "00:00:00.1234567",
  "CurrentPlaySessionTimeStay": "00:00:00.1234567",
  "TotalViewedSlidesCount": 3,
  "CurrentPlaySessionViewedSlidesCount": 4
}

application/xml, text/xml

Sample:

<StorylineSlidesProgress xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Adevico.xApi_LRC.Models">
  <CurrentPlaySessionTimeStay>PT0.1234567S</CurrentPlaySessionTimeStay>
  <CurrentPlaySessionViewedSlidesCount>4</CurrentPlaySessionViewedSlidesCount>
  <StorylineState>NOT_STARTED</StorylineState>
  <TotalTimeStay>PT0.1234567S</TotalTimeStay>
  <TotalViewedSlidesCount>3</TotalViewedSlidesCount>
</StorylineSlidesProgress>