POST api/LMS.LearningStatus/Filter

POST api/LMS/LearningStatus/Filter LMS All Services

Filter LearningStatus with parameters given in the filter body LearningStatus: NotAttempted: 0 Failed: 1 Browsed: 2 InProgress: 3 Completed: 4 Passed: 5

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.

LearningStatusFilterModel

LearningStatusFilterModel:

PropertyName	Type	Required
EnrollmentIDs	IEnumerable<Int32>	Optional
LoginNames	IEnumerable<String>	Optional
CourseCodes	IEnumerable<String>	Optional
LearningStatus	IEnumerable<LearningStates>	Optional
CompletionDateFrom	Nullable<DateTime>	Optional
CompletionDateTo	Nullable<DateTime>	Optional
AttemptedDateTo	Nullable<DateTime>	Optional
AttemptedDateFrom	Nullable<DateTime>	Optional
IncludeInactive	Nullable<Boolean>	Optional
IncludeAllLessons	Nullable<Boolean>	Optional
IsDeleted	Nullable<Boolean>	Optional
IsCourseActive	Nullable<Boolean>	Optional

Request body formats

application/json, text/json

Sample:

{
  "EnrollmentIDs": [
    1,
    2,
    3
  ],
  "LoginNames": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ],
  "CourseCodes": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ],
  "LearningStatus": [
    0,
    0,
    0
  ],
  "CompletionDateFrom": "2025-05-11T13:46:55.5314804+00:00",
  "CompletionDateTo": "2025-05-11T13:46:55.5314804+00:00",
  "AttemptedDateTo": "2025-05-11T13:46:55.5314804+00:00",
  "AttemptedDateFrom": "2025-05-11T13:46:55.5314804+00:00",
  "IncludeInactive": true,
  "IncludeAllLessons": true,
  "IsDeleted": true,
  "IsCourseActive": true
}

application/xml, text/xml

Sample:

<LearningStatusFilterModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LMS.DomainServices.Models">
  <AttemptedDateFrom>2025-05-11T13:46:55.5314804+00:00</AttemptedDateFrom>
  <AttemptedDateTo>2025-05-11T13:46:55.5314804+00:00</AttemptedDateTo>
  <CompletionDateFrom>2025-05-11T13:46:55.5314804+00:00</CompletionDateFrom>
  <CompletionDateTo>2025-05-11T13:46:55.5314804+00:00</CompletionDateTo>
  <CourseCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
    <d2p1:string>sample string 3</d2p1:string>
  </CourseCodes>
  <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>
  <IncludeAllLessons>true</IncludeAllLessons>
  <IncludeInactive>true</IncludeInactive>
  <IsCourseActive>true</IsCourseActive>
  <IsDeleted>true</IsDeleted>
  <LearningStatus>
    <LearningStates>NotAttempted</LearningStates>
    <LearningStates>NotAttempted</LearningStates>
    <LearningStates>NotAttempted</LearningStates>
  </LearningStatus>
  <LoginNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
    <d2p1:string>sample string 3</d2p1:string>
  </LoginNames>
</LearningStatusFilterModel>

Return Type

Return type

LearningStatusDTO[]

LearningStatusDTO:

PropertyName	Type	Required
EnrollmentID	Int32	Display
LoginName	String	Mandatory
CourseCode	String	Mandatory
Status	String	Optional
Score	Int32	Optional
TotalTime	String	Optional
CompletionDate	Nullable<DateTime>	Optional
AttemptNumber	Int32	Display

Response Information

Response body formats

application/json, text/json

Sample:

[
  {
    "EnrollmentID": 1,
    "LoginName": "sample string 2",
    "CourseCode": "sample string 3",
    "Status": "sample string 4",
    "Score": 5,
    "TotalTime": "sample string 6",
    "CompletionDate": "2025-05-11T13:46:55.5471021+00:00",
    "AttemptNumber": 7
  },
  {
    "EnrollmentID": 1,
    "LoginName": "sample string 2",
    "CourseCode": "sample string 3",
    "Status": "sample string 4",
    "Score": 5,
    "TotalTime": "sample string 6",
    "CompletionDate": "2025-05-11T13:46:55.5471021+00:00",
    "AttemptNumber": 7
  },
  {
    "EnrollmentID": 1,
    "LoginName": "sample string 2",
    "CourseCode": "sample string 3",
    "Status": "sample string 4",
    "Score": 5,
    "TotalTime": "sample string 6",
    "CompletionDate": "2025-05-11T13:46:55.5471021+00:00",
    "AttemptNumber": 7
  }
]

application/xml, text/xml

Sample:

<ArrayOfLearningStatusDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LMS.API.Service.Models.LMS">
  <LearningStatusDTO>
    <CompletionDate>2025-05-11T13:46:55.5471021+00:00</CompletionDate>
    <CourseCode>sample string 3</CourseCode>
    <EnrollmentID>1</EnrollmentID>
    <LoginName>sample string 2</LoginName>
    <Score>5</Score>
    <Status>sample string 4</Status>
    <TotalTime>sample string 6</TotalTime>
  </LearningStatusDTO>
  <LearningStatusDTO>
    <CompletionDate>2025-05-11T13:46:55.5471021+00:00</CompletionDate>
    <CourseCode>sample string 3</CourseCode>
    <EnrollmentID>1</EnrollmentID>
    <LoginName>sample string 2</LoginName>
    <Score>5</Score>
    <Status>sample string 4</Status>
    <TotalTime>sample string 6</TotalTime>
  </LearningStatusDTO>
  <LearningStatusDTO>
    <CompletionDate>2025-05-11T13:46:55.5471021+00:00</CompletionDate>
    <CourseCode>sample string 3</CourseCode>
    <EnrollmentID>1</EnrollmentID>
    <LoginName>sample string 2</LoginName>
    <Score>5</Score>
    <Status>sample string 4</Status>
    <TotalTime>sample string 6</TotalTime>
  </LearningStatusDTO>
</ArrayOfLearningStatusDTO>