POST api/LMS.Enrollments/Filter

POST api/LMS/Enrollments/Filter LMS All Services

Gets all enrollments that match the parameters inside the filter body. LearningStates: 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.

EnrollmentFilterModel

EnrollmentFilterModel:

PropertyName	Type	Required
LoginName	String	Optional
EmployeeID	String	Optional
UserGroup	String	Optional
CourseCode	String	Optional
CourseGroupID	Int32	Optional
IncludeSubGroups	Boolean	Optional
LearningStatus	IEnumerable<LearningStates>	Optional
CompletionDateFrom	Nullable<DateTime>	Optional
CompletionDateTo	Nullable<DateTime>	Optional
ExpiryDateFrom	Nullable<DateTime>	Optional
ExpiryDateTo	Nullable<DateTime>	Optional
EnrolledDateFrom	Nullable<DateTime>	Optional
EnrolledDateTo	Nullable<DateTime>	Optional
IsActive	Nullable<Boolean>	Optional
IsCourseActive	Nullable<Boolean>	Optional

Request body formats

application/json, text/json

Sample:

{
  "LoginName": "sample string 1",
  "EmployeeID": "sample string 2",
  "UserGroup": "sample string 3",
  "CourseCode": "sample string 4",
  "CourseGroupID": 5,
  "IncludeSubGroups": true,
  "LearningStatus": [
    0,
    0,
    0
  ],
  "CompletionDateFrom": "2025-05-11T14:25:51.6737015+00:00",
  "CompletionDateTo": "2025-05-11T14:25:51.6737015+00:00",
  "ExpiryDateFrom": "2025-05-11T14:25:51.6737015+00:00",
  "ExpiryDateTo": "2025-05-11T14:25:51.6737015+00:00",
  "EnrolledDateFrom": "2025-05-11T14:25:51.6737015+00:00",
  "EnrolledDateTo": "2025-05-11T14:25:51.6737015+00:00",
  "IsActive": true,
  "IsCourseActive": true
}

application/xml, text/xml

Sample:

<EnrollmentFilterModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LMS.DomainServices.Models">
  <CompletionDateFrom>2025-05-11T14:25:51.6737015+00:00</CompletionDateFrom>
  <CompletionDateTo>2025-05-11T14:25:51.6737015+00:00</CompletionDateTo>
  <CourseCode>sample string 4</CourseCode>
  <CourseGroupID>5</CourseGroupID>
  <EmployeeID>sample string 2</EmployeeID>
  <EnrolledDateFrom>2025-05-11T14:25:51.6737015+00:00</EnrolledDateFrom>
  <EnrolledDateTo>2025-05-11T14:25:51.6737015+00:00</EnrolledDateTo>
  <ExpiryDateFrom>2025-05-11T14:25:51.6737015+00:00</ExpiryDateFrom>
  <ExpiryDateTo>2025-05-11T14:25:51.6737015+00:00</ExpiryDateTo>
  <IncludeSubGroups>true</IncludeSubGroups>
  <IsActive>true</IsActive>
  <IsCourseActive>true</IsCourseActive>
  <LearningStatus>
    <LearningStates>NotAttempted</LearningStates>
    <LearningStates>NotAttempted</LearningStates>
    <LearningStates>NotAttempted</LearningStates>
  </LearningStatus>
  <LoginName>sample string 1</LoginName>
  <UserGroup>sample string 3</UserGroup>
</EnrollmentFilterModel>

Return Type

Return type

EnrollmentDTO[]

EnrollmentDTO:

PropertyName	Type	Required	Description
EnrollmentID	Int32	Display
LoginName	String	Mandatory	Maximum length: 50 chars
CourseCode	String	Mandatory	Maximum length: 50 chars
StartDate	DateTime	Conditional
ExpiryDate	Nullable<DateTime>	Conditional
LastLaunched	Nullable<Int32>	Optional
Instructor	String	Optional
ReservationNumber	String	Optional	For modification operation,to remove the value of reservation number, pass an empty string.Passing null value or missing reservation number in request body will let the reservation keep its previous value.

Response Information

Response body formats

application/json, text/json

Sample:

[
  {
    "EnrollmentID": 1,
    "LoginName": "sample string 2",
    "CourseCode": "sample string 3",
    "StartDate": "2025-05-11T14:25:51.7050147+00:00",
    "ExpiryDate": "2025-05-11T14:25:51.7050147+00:00",
    "LastLaunched": 1,
    "Instructor": "sample string 5",
    "ReservationNumber": "sample string 6"
  },
  {
    "EnrollmentID": 1,
    "LoginName": "sample string 2",
    "CourseCode": "sample string 3",
    "StartDate": "2025-05-11T14:25:51.7050147+00:00",
    "ExpiryDate": "2025-05-11T14:25:51.7050147+00:00",
    "LastLaunched": 1,
    "Instructor": "sample string 5",
    "ReservationNumber": "sample string 6"
  },
  {
    "EnrollmentID": 1,
    "LoginName": "sample string 2",
    "CourseCode": "sample string 3",
    "StartDate": "2025-05-11T14:25:51.7050147+00:00",
    "ExpiryDate": "2025-05-11T14:25:51.7050147+00:00",
    "LastLaunched": 1,
    "Instructor": "sample string 5",
    "ReservationNumber": "sample string 6"
  }
]

application/xml, text/xml

Sample:

<ArrayOfEnrollmentDTO xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <EnrollmentDTO>
    <EnrollmentID>1</EnrollmentID>
    <LoginName>sample string 2</LoginName>
    <CourseCode>sample string 3</CourseCode>
    <StartDate>2025-05-11T14:25:51.7050147+00:00</StartDate>
    <ExpiryDate>2025-05-11T14:25:51.7050147+00:00</ExpiryDate>
    <LastLaunched>1</LastLaunched>
    <Instructor>sample string 5</Instructor>
    <ReservationNumber>sample string 6</ReservationNumber>
  </EnrollmentDTO>
  <EnrollmentDTO>
    <EnrollmentID>1</EnrollmentID>
    <LoginName>sample string 2</LoginName>
    <CourseCode>sample string 3</CourseCode>
    <StartDate>2025-05-11T14:25:51.7050147+00:00</StartDate>
    <ExpiryDate>2025-05-11T14:25:51.7050147+00:00</ExpiryDate>
    <LastLaunched>1</LastLaunched>
    <Instructor>sample string 5</Instructor>
    <ReservationNumber>sample string 6</ReservationNumber>
  </EnrollmentDTO>
  <EnrollmentDTO>
    <EnrollmentID>1</EnrollmentID>
    <LoginName>sample string 2</LoginName>
    <CourseCode>sample string 3</CourseCode>
    <StartDate>2025-05-11T14:25:51.7050147+00:00</StartDate>
    <ExpiryDate>2025-05-11T14:25:51.7050147+00:00</ExpiryDate>
    <LastLaunched>1</LastLaunched>
    <Instructor>sample string 5</Instructor>
    <ReservationNumber>sample string 6</ReservationNumber>
  </EnrollmentDTO>
</ArrayOfEnrollmentDTO>