POST api/SkillaTracking/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
SkillaRequestBody| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId | string |
None. |
|
| CommunityId | string |
None. |
|
| OrganizationId | string |
None. |
|
| CurrentPlayUniqueSessionId | string |
None. |
|
| SkillaGuid | string |
None. |
|
| isLink | 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",
"SkillaGuid": "sample string 5",
"isLink": "sample string 6"
}
application/xml, text/xml
Sample:
<SkillaRequestBody 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> <SkillaGuid>sample string 5</SkillaGuid> <UserId>sample string 1</UserId> <isLink>sample string 6</isLink> </SkillaRequestBody>
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
SkillaProgress| Name | Description | Type | Additional information |
|---|---|---|---|
| SkillaState | SkillaState |
None. |
|
| TotalTimeStay | time interval |
None. |
|
| CurrentPlaySessionTimeStay | time interval |
None. |
Response Formats
application/json, text/json
Sample:
{
"SkillaState": 0,
"TotalTimeStay": "00:00:00.1234567",
"CurrentPlaySessionTimeStay": "00:00:00.1234567"
}
application/xml, text/xml
Sample:
<SkillaProgress xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Adevico.xApi_LRC.Models"> <CurrentPlaySessionTimeStay>PT0.1234567S</CurrentPlaySessionTimeStay> <SkillaState>NOT_STARTED</SkillaState> <TotalTimeStay>PT0.1234567S</TotalTimeStay> </SkillaProgress>