GET api/LMS/Enrollments/DefaultAction   LMS   All Services

This service returns all active enrollments. (Note: 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]

Return Type

Return typeEnrollmentDTO[]
EnrollmentDTO:
PropertyNameTypeRequiredDescription
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:56:15.9786163+00:00",
    "ExpiryDate": "2025-05-11T14:56:15.9786163+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:56:15.9786163+00:00",
    "ExpiryDate": "2025-05-11T14:56:15.9786163+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:56:15.9786163+00:00",
    "ExpiryDate": "2025-05-11T14:56:15.9786163+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:56:15.9786163+00:00</StartDate>
    <ExpiryDate>2025-05-11T14:56:15.9786163+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:56:15.9786163+00:00</StartDate>
    <ExpiryDate>2025-05-11T14:56:15.9786163+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:56:15.9786163+00:00</StartDate>
    <ExpiryDate>2025-05-11T14:56:15.9786163+00:00</ExpiryDate>
    <LastLaunched>1</LastLaunched>
    <Instructor>sample string 5</Instructor>
    <ReservationNumber>sample string 6</ReservationNumber>
  </EnrollmentDTO>
</ArrayOfEnrollmentDTO>