GET api/LMS/LearningStatus/GetBy?LoginName={LoginName}&CourseCode={CourseCode}&LearningStatus={LearningStatus}&CompletionRange={CompletionRange}&UserGroupId={UserGroupId}&IncludeInactive={IncludeInactive}   LMS   All Services

This service returns the learning status for active enrollments that are based on the passed in parameters. (Note: It is an “exact” match on any/all of the parameters. 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

NameDescriptionAdditional informationType
LoginName 
max 50 characters

Define this parameter in the request URI.

 String
CourseCode 
max 50 characters

Define this parameter in the request URI.

 String
LearningStatus 
'Completed','Passed','Failed','Incomplete','Not Attempted'

Define this parameter in the request URI.

 String
CompletionRange 
integer value return Learning date within X-hours

Define this parameter in the request URI.

 String
UserGroupId 
ID of the UserGroup to filter all LearningStatus by

Define this parameter in the request URI.

 Nullable<Int32>
IncludeInactive 
bool value to determine whether or not inactive enrollments should be returned or not

Define this parameter in the request URI.

 Boolean

Return Type

Return typeLearningStatusDTO[]
LearningStatusDTO:
PropertyNameTypeRequiredDescription
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-11T14:07:43.9768924+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-11T14:07:43.9768924+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-11T14:07:43.9768924+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-11T14:07:43.9768924+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-11T14:07:43.9768924+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-11T14:07:43.9768924+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>