GET api/LMS/LearningStatus/GetByEnrollmentID?EnrollmentID={EnrollmentID} LMS All Services
This service returns the learning status for an enrollment that is based on the EnrollmentID. (Note: It is an “exact” match on enrollment ID value.)
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 |
---|---|---|---|
EnrollmentID | Integer |
Define this parameter in the request URI. |
Int32 |
Return Type
Return type | LearningStatusDTO | ||||||||||||||||||||||||||||||||||||||
|
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:47:49.0058878+00:00", "AttemptNumber": 7 }
application/xml, text/xml
Sample:
<LearningStatusDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LMS.API.Service.Models.LMS"> <CompletionDate>2025-05-11T13:47:49.0058878+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>