POST classroomAPI/LMS/getPrimaryLRSCourseStats

Request Information

URI Parameters

None.

Body Parameters

PrimaryLRSCourseStats
NameDescriptionTypeAdditional information
companyID

integer

None.

startDate

date

None.

endDate

date

None.

userID

integer

None.

objectID

globally unique identifier

None.

verbID

globally unique identifier

None.

deliveryTypeToExclude

integer

None.

deliveryTypeToInclude

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "companyID": 1,
  "startDate": "2024-11-25T04:22:02.4817533-05:00",
  "endDate": "2024-11-25T04:22:02.4817533-05:00",
  "userID": 1,
  "objectID": "7ecb976a-6189-4d43-8111-e51048d4e342",
  "verbID": "b52d5456-2aef-4c8d-b202-b70c4fe90b92",
  "deliveryTypeToExclude": 1,
  "deliveryTypeToInclude": 1
}

application/xml, text/xml

Sample:
<PrimaryLRSCourseStats xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Classroom.ClassroomBLL">
  <companyID>1</companyID>
  <deliveryTypeToExclude>1</deliveryTypeToExclude>
  <deliveryTypeToInclude>1</deliveryTypeToInclude>
  <endDate>2024-11-25T04:22:02.4817533-05:00</endDate>
  <objectID>7ecb976a-6189-4d43-8111-e51048d4e342</objectID>
  <startDate>2024-11-25T04:22:02.4817533-05:00</startDate>
  <userID>1</userID>
  <verbID>b52d5456-2aef-4c8d-b202-b70c4fe90b92</verbID>
</PrimaryLRSCourseStats>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LRSPrimaryStatContainer
NameDescriptionTypeAdditional information
CourseStats

Object

None.

DeliveryTypes

Object

None.

Response Formats

application/json, text/json

Sample:
{
  "CourseStats": {},
  "DeliveryTypes": {}
}

application/xml, text/xml

Sample:
<LRSPrimaryStatContainer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Classroom.ClassroomBLL">
  <CourseStats />
  <DeliveryTypes />
</LRSPrimaryStatContainer>