GET api/LMS/Enrollments/GetBy?LoginName={LoginName}&CourseCode={CourseCode}&UserGroup={UserGroup}&EnrolledDateFrom={EnrolledDateFrom}&EnrolledDateTo={EnrolledDateTo} LMS All Services
This service returns all active enrollments that match the passed in filter combination of LoginName, CourseCode, and UserGroup. (Note: It is an “exact” match on all filters combined together.It does not include inactive or withdrawn enrollments.)
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 |
|---|---|---|---|
| LoginName | max 50 characters |
Define this parameter in the request URI. |
String |
| CourseCode | max 50 characters |
Define this parameter in the request URI. |
String |
| UserGroup | max 100 characters |
Define this parameter in the request URI. |
String |
| EnrolledDateFrom | DateTime (YYYY-MM-dd HH:mm) |
Define this parameter in the request URI. |
Nullable<DateTime> |
| EnrolledDateTo | DateTime (YYYY-MM-dd HH:mm) |
Define this parameter in the request URI. |
Nullable<DateTime> |
Return Type
| Return type | EnrollmentDTO[] | ||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
Response Information
Response body formats
application/json, text/json
Sample:
[
{
"EnrollmentID": 1,
"LoginName": "sample string 2",
"CourseCode": "sample string 3",
"StartDate": "2025-10-27T17:10:03.7066105+00:00",
"ExpiryDate": "2025-10-27T17:10:03.7066105+00:00",
"LastLaunched": 1,
"Instructor": "sample string 5",
"ReservationNumber": "sample string 6"
},
{
"EnrollmentID": 1,
"LoginName": "sample string 2",
"CourseCode": "sample string 3",
"StartDate": "2025-10-27T17:10:03.7066105+00:00",
"ExpiryDate": "2025-10-27T17:10:03.7066105+00:00",
"LastLaunched": 1,
"Instructor": "sample string 5",
"ReservationNumber": "sample string 6"
},
{
"EnrollmentID": 1,
"LoginName": "sample string 2",
"CourseCode": "sample string 3",
"StartDate": "2025-10-27T17:10:03.7066105+00:00",
"ExpiryDate": "2025-10-27T17:10:03.7066105+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-10-27T17:10:03.7066105+00:00</StartDate>
<ExpiryDate>2025-10-27T17:10:03.7066105+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-10-27T17:10:03.7066105+00:00</StartDate>
<ExpiryDate>2025-10-27T17:10:03.7066105+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-10-27T17:10:03.7066105+00:00</StartDate>
<ExpiryDate>2025-10-27T17:10:03.7066105+00:00</ExpiryDate>
<LastLaunched>1</LastLaunched>
<Instructor>sample string 5</Instructor>
<ReservationNumber>sample string 6</ReservationNumber>
</EnrollmentDTO>
</ArrayOfEnrollmentDTO>