GET api/LMS/DetailedLearningStatus/GetByEnrollmentID?EnrollmentID={EnrollmentID}   LMS   All Services

This service returns the detailed 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

NameDescriptionAdditional informationType
EnrollmentID 
Integer

Define this parameter in the request URI.

 Int32

Return Type

Return typeDetailedLearningStatusDTO[]
DetailedLearningStatusDTO:
PropertyNameTypeRequiredDescription
EnrollmentID Int32 Display
LoginName String Mandatory Maximum length: 50 chars
CourseCode String Mandatory Maximum length: 50 chars
LessonId Int32 Display
LessonTitle String Optional Maximum length: 50 chars
LessonType String Optional Maximum length: 25 chars
Status String Optional Maximum length: 25 chars
Score Int32 Optional
TotalTime String Optional Maximum length: 25 chars
CompletionDate Nullable<DateTime> Optional
AttemptNumber Int32 Optional
TreeStructure String Optional Maximum length: 50 chars

Response Information

Response body formats

application/json, text/json

Sample: 
[
  {
    "EnrollmentID": 1,
    "LoginName": "sample string 2",
    "CourseCode": "sample string 3",
    "LessonId": 4,
    "LessonTitle": "sample string 5",
    "LessonType": "sample string 6",
    "Status": "sample string 7",
    "Score": 8,
    "TotalTime": "sample string 9",
    "CompletionDate": "2025-05-11T13:15:56.9548136+00:00",
    "AttemptNumber": 10,
    "TreeStructure": "sample string 11"
  },
  {
    "EnrollmentID": 1,
    "LoginName": "sample string 2",
    "CourseCode": "sample string 3",
    "LessonId": 4,
    "LessonTitle": "sample string 5",
    "LessonType": "sample string 6",
    "Status": "sample string 7",
    "Score": 8,
    "TotalTime": "sample string 9",
    "CompletionDate": "2025-05-11T13:15:56.9548136+00:00",
    "AttemptNumber": 10,
    "TreeStructure": "sample string 11"
  },
  {
    "EnrollmentID": 1,
    "LoginName": "sample string 2",
    "CourseCode": "sample string 3",
    "LessonId": 4,
    "LessonTitle": "sample string 5",
    "LessonType": "sample string 6",
    "Status": "sample string 7",
    "Score": 8,
    "TotalTime": "sample string 9",
    "CompletionDate": "2025-05-11T13:15:56.9548136+00:00",
    "AttemptNumber": 10,
    "TreeStructure": "sample string 11"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfDetailedLearningStatusDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LMS.API.Service.Models.LMS">
  <DetailedLearningStatusDTO>
    <AttemptNumber>10</AttemptNumber>
    <CompletionDate>2025-05-11T13:15:56.9548136+00:00</CompletionDate>
    <CourseCode>sample string 3</CourseCode>
    <EnrollmentID>1</EnrollmentID>
    <LessonTitle>sample string 5</LessonTitle>
    <LessonType>sample string 6</LessonType>
    <LoginName>sample string 2</LoginName>
    <Score>8</Score>
    <Status>sample string 7</Status>
    <TotalTime>sample string 9</TotalTime>
    <TreeStructure>sample string 11</TreeStructure>
  </DetailedLearningStatusDTO>
  <DetailedLearningStatusDTO>
    <AttemptNumber>10</AttemptNumber>
    <CompletionDate>2025-05-11T13:15:56.9548136+00:00</CompletionDate>
    <CourseCode>sample string 3</CourseCode>
    <EnrollmentID>1</EnrollmentID>
    <LessonTitle>sample string 5</LessonTitle>
    <LessonType>sample string 6</LessonType>
    <LoginName>sample string 2</LoginName>
    <Score>8</Score>
    <Status>sample string 7</Status>
    <TotalTime>sample string 9</TotalTime>
    <TreeStructure>sample string 11</TreeStructure>
  </DetailedLearningStatusDTO>
  <DetailedLearningStatusDTO>
    <AttemptNumber>10</AttemptNumber>
    <CompletionDate>2025-05-11T13:15:56.9548136+00:00</CompletionDate>
    <CourseCode>sample string 3</CourseCode>
    <EnrollmentID>1</EnrollmentID>
    <LessonTitle>sample string 5</LessonTitle>
    <LessonType>sample string 6</LessonType>
    <LoginName>sample string 2</LoginName>
    <Score>8</Score>
    <Status>sample string 7</Status>
    <TotalTime>sample string 9</TotalTime>
    <TreeStructure>sample string 11</TreeStructure>
  </DetailedLearningStatusDTO>
</ArrayOfDetailedLearningStatusDTO>