POST api/LMS.Attempts/Filter

POST api/LMS/Attempts/Filter LMS All Services

Filter Attempts with parameters given in the filter body [AttemptStatus]: NotAttempted: 0 Failed: 1 Browsed: 2 Incomplete: 3 Completed: 4 Passed: 5 (Note: DateTime filters are calculated in UTC format(YYYY-MM-dd HH:mm) OR UTCformat(YYYY-MM-DDThh:mm:ssZ) and are inclusive)

Request Information

Headers

Fields	Type	M/O/C	Definition
AccountLoginName	String(50)	Mandatory	Login name of an account used for logging into Galaxy application to perform the service call
AccountPassword	String(50)	Mandatory	Password of an account used for logging into Galaxy application to perform the service call
SourceSystemID	String(50)	Mandatory	Name or ID of application or system that initiated the call.
DomainID	String(50)	Mandatory	Name or ID of the domain that the call is being made to. (Value will be 1, if the site only has one domain)
Accept	String	Optional	Format in which client expects the response: [application/json] (default), [application/xml]
ContentType	String	Optional	Format in which client is sending the request: [application/json] (default), [application/xml]

Parameters

Name

Description

Additional information

Type

filterModel

Define this parameter in the request body.

LessonAttemptFilter

LessonAttemptFilter:

PropertyName	Type	Required
EnrollmentIDs	IEnumerable<Int32>	Optional
LessonIDs	IEnumerable<Int32>	Optional
AttemptStatus	IEnumerable<LearningStates>	Optional
AttemptedDateTo	Nullable<DateTime>	Optional
AttemptedDateFrom	Nullable<DateTime>	Optional

Request body formats

application/json, text/json

Sample:

{
  "EnrollmentIDs": [
    1,
    2,
    3
  ],
  "LessonIDs": [
    1,
    2,
    3
  ],
  "AttemptStatus": [
    0,
    0,
    0
  ],
  "AttemptedDateTo": "2025-05-11T13:23:03.938984+00:00",
  "AttemptedDateFrom": "2025-05-11T13:23:03.938984+00:00"
}

application/xml, text/xml

Sample:

<LessonAttemptFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LMS.DomainServices.Models">
  <AttemptStatus>
    <LearningStates>NotAttempted</LearningStates>
    <LearningStates>NotAttempted</LearningStates>
    <LearningStates>NotAttempted</LearningStates>
  </AttemptStatus>
  <AttemptedDateFrom>2025-05-11T13:23:03.938984+00:00</AttemptedDateFrom>
  <AttemptedDateTo>2025-05-11T13:23:03.938984+00:00</AttemptedDateTo>
  <EnrollmentIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
    <d2p1:int>3</d2p1:int>
  </EnrollmentIDs>
  <LessonIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
    <d2p1:int>3</d2p1:int>
  </LessonIDs>
</LessonAttemptFilter>

Return Type

Return type

LessonAttemptDTO[]

LessonAttemptDTO:

PropertyName	Type	Required
AttemptID	Int32	Optional
LoginName	String	Optional
CourseTitle	String	Optional
CourseCode	String	Optional
AttemptStatus	String	Optional
AttemptScore	String	Optional
AttemptTime	String	Optional
AttemptDate	Nullable<DateTime>	Optional

Response Information

Response body formats

application/json, text/json

Sample:

[
  {
    "AttemptID": 1,
    "LoginName": "sample string 2",
    "CourseTitle": "sample string 3",
    "CourseCode": "sample string 4",
    "AttemptStatus": "sample string 5",
    "AttemptScore": "sample string 6",
    "AttemptTime": "sample string 7",
    "AttemptDate": "2025-05-11T13:23:03.9650094+00:00"
  },
  {
    "AttemptID": 1,
    "LoginName": "sample string 2",
    "CourseTitle": "sample string 3",
    "CourseCode": "sample string 4",
    "AttemptStatus": "sample string 5",
    "AttemptScore": "sample string 6",
    "AttemptTime": "sample string 7",
    "AttemptDate": "2025-05-11T13:23:03.9650094+00:00"
  },
  {
    "AttemptID": 1,
    "LoginName": "sample string 2",
    "CourseTitle": "sample string 3",
    "CourseCode": "sample string 4",
    "AttemptStatus": "sample string 5",
    "AttemptScore": "sample string 6",
    "AttemptTime": "sample string 7",
    "AttemptDate": "2025-05-11T13:23:03.9650094+00:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfLessonAttemptDTO xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <LessonAttemptDTO>
    <AttemptID>1</AttemptID>
    <LoginName>sample string 2</LoginName>
    <CourseTitle>sample string 3</CourseTitle>
    <CourseCode>sample string 4</CourseCode>
    <AttemptStatus>sample string 5</AttemptStatus>
    <AttemptScore>sample string 6</AttemptScore>
    <AttemptTime>sample string 7</AttemptTime>
    <AttemptDate>2025-05-11T13:23:03.9650094+00:00</AttemptDate>
  </LessonAttemptDTO>
  <LessonAttemptDTO>
    <AttemptID>1</AttemptID>
    <LoginName>sample string 2</LoginName>
    <CourseTitle>sample string 3</CourseTitle>
    <CourseCode>sample string 4</CourseCode>
    <AttemptStatus>sample string 5</AttemptStatus>
    <AttemptScore>sample string 6</AttemptScore>
    <AttemptTime>sample string 7</AttemptTime>
    <AttemptDate>2025-05-11T13:23:03.9650094+00:00</AttemptDate>
  </LessonAttemptDTO>
  <LessonAttemptDTO>
    <AttemptID>1</AttemptID>
    <LoginName>sample string 2</LoginName>
    <CourseTitle>sample string 3</CourseTitle>
    <CourseCode>sample string 4</CourseCode>
    <AttemptStatus>sample string 5</AttemptStatus>
    <AttemptScore>sample string 6</AttemptScore>
    <AttemptTime>sample string 7</AttemptTime>
    <AttemptDate>2025-05-11T13:23:03.9650094+00:00</AttemptDate>
  </LessonAttemptDTO>
</ArrayOfLessonAttemptDTO>