GET restapi/personal/progressreport/{personId}/v1?subjectId={subjectId}&fromDateTime={fromDateTime}&toDateTime={toDateTime}&statuses={statuses}
Gets the person learning objectives aggregated progress report.
The client of this API may supply additional parameters to get a more detailed report. For instance supplying a time period parameters (fromDateTime and toDateTime) one can get a report only in this particular time period.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| personId |
[Required] The person identifier. Required to get a report. |
integer |
Required |
| subjectId |
[Required] The subject id. Required to get a report. |
integer |
Required |
| fromDateTime |
[Optional] Report period start date. Optional, if not supplied a date of the earliest learning objective assessment date is used. Date has to contain also time in , for ex. YYYY-MM-DDTHH:MM:SS.sssssss or YYYY-MM-DD HH:MM:SS. |
date |
None. |
| toDateTime |
[Optional] Report period stop date. Optional, if not supplied the current date is used. Date has to contain also time in , for ex. YYYY-MM-DDTHH:MM:SS.sssssss or YYYY-MM-DD HH:MM:SS. |
date |
None. |
| statuses |
[Optional] The learning objective statuses types to filter by. |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
Person learning objectives aggregated progress report.
Itslearning.RestApi.Entities.LearningObjectiveProgressReport.AggregatedReport| Name | Description | Type | Additional information |
|---|---|---|---|
| SubjectId |
The subject id a report is constructed for. |
integer |
None. |
| SubjectSummary |
A list of assessment status entities representing summary information about the subject. (e.g. how many Meets, Exceeds etc. assessment status items are there). |
Collection of Itslearning.RestApi.Entities.LearningObjectiveProgressReport.AggregatedReportAssessmentStatus |
None. |
| SubjectMasteryPercentage |
The percentage of mastered learning objectives in the subject (across all clusters). (it is calculated as percentage from all assessed learning objectives in the cluster). |
decimal number |
None. |
| Clusters |
The list of learning objective clusters in the current subject. |
Collection of Itslearning.RestApi.Entities.LearningObjectiveProgressReport.ReportCluster |
None. |
| UseMastery |
Indicates whether mastery is used. |
boolean |
None. |
| FullReportUrl |
Full report URL. Directs to a person profile page with learning objectives tab selected. |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"SubjectId": 1,
"SubjectSummary": [
{
"Count": 1,
"Label": "sample string 2",
"StatusType": 3
},
{
"Count": 1,
"Label": "sample string 2",
"StatusType": 3
}
],
"SubjectMasteryPercentage": 2.1,
"Clusters": [
{
"ClusterId": 1,
"Title": "sample string 2",
"Description": "sample string 3",
"ClusterSummary": [
{
"Count": 1,
"Label": "sample string 2",
"StatusType": 3
},
{
"Count": 1,
"Label": "sample string 2",
"StatusType": 3
}
],
"ClusterMasteryPercentage": 4.1,
"Groups": [
{
"GroupId": 1,
"Parents": [
{
"Id": 1,
"Title": "sample string 2",
"Description": "sample string 3"
},
{
"Id": 1,
"Title": "sample string 2",
"Description": "sample string 3"
}
],
"ReportGroupItems": [
{
"LearningObjectiveId": 1,
"Title": "sample string 2",
"Description": "sample string 3",
"Status": {
"Label": "sample string 1",
"StatusType": 2
},
"Mastered": true,
"MasteredDate": "2025-06-25T14:40:37Z"
},
{
"LearningObjectiveId": 1,
"Title": "sample string 2",
"Description": "sample string 3",
"Status": {
"Label": "sample string 1",
"StatusType": 2
},
"Mastered": true,
"MasteredDate": "2025-06-25T14:40:37Z"
}
]
},
{
"GroupId": 1,
"Parents": [
{
"Id": 1,
"Title": "sample string 2",
"Description": "sample string 3"
},
{
"Id": 1,
"Title": "sample string 2",
"Description": "sample string 3"
}
],
"ReportGroupItems": [
{
"LearningObjectiveId": 1,
"Title": "sample string 2",
"Description": "sample string 3",
"Status": {
"Label": "sample string 1",
"StatusType": 2
},
"Mastered": true,
"MasteredDate": "2025-06-25T14:40:37Z"
},
{
"LearningObjectiveId": 1,
"Title": "sample string 2",
"Description": "sample string 3",
"Status": {
"Label": "sample string 1",
"StatusType": 2
},
"Mastered": true,
"MasteredDate": "2025-06-25T14:40:37Z"
}
]
}
]
},
{
"ClusterId": 1,
"Title": "sample string 2",
"Description": "sample string 3",
"ClusterSummary": [
{
"Count": 1,
"Label": "sample string 2",
"StatusType": 3
},
{
"Count": 1,
"Label": "sample string 2",
"StatusType": 3
}
],
"ClusterMasteryPercentage": 4.1,
"Groups": [
{
"GroupId": 1,
"Parents": [
{
"Id": 1,
"Title": "sample string 2",
"Description": "sample string 3"
},
{
"Id": 1,
"Title": "sample string 2",
"Description": "sample string 3"
}
],
"ReportGroupItems": [
{
"LearningObjectiveId": 1,
"Title": "sample string 2",
"Description": "sample string 3",
"Status": {
"Label": "sample string 1",
"StatusType": 2
},
"Mastered": true,
"MasteredDate": "2025-06-25T14:40:37Z"
},
{
"LearningObjectiveId": 1,
"Title": "sample string 2",
"Description": "sample string 3",
"Status": {
"Label": "sample string 1",
"StatusType": 2
},
"Mastered": true,
"MasteredDate": "2025-06-25T14:40:37Z"
}
]
},
{
"GroupId": 1,
"Parents": [
{
"Id": 1,
"Title": "sample string 2",
"Description": "sample string 3"
},
{
"Id": 1,
"Title": "sample string 2",
"Description": "sample string 3"
}
],
"ReportGroupItems": [
{
"LearningObjectiveId": 1,
"Title": "sample string 2",
"Description": "sample string 3",
"Status": {
"Label": "sample string 1",
"StatusType": 2
},
"Mastered": true,
"MasteredDate": "2025-06-25T14:40:37Z"
},
{
"LearningObjectiveId": 1,
"Title": "sample string 2",
"Description": "sample string 3",
"Status": {
"Label": "sample string 1",
"StatusType": 2
},
"Mastered": true,
"MasteredDate": "2025-06-25T14:40:37Z"
}
]
}
]
}
],
"UseMastery": true,
"FullReportUrl": "sample string 4"
}
application/xml, text/xml
Sample:
<AggregatedReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Clusters>
<ReportCluster>
<ClusterId>1</ClusterId>
<ClusterMasteryPercentage>4.1</ClusterMasteryPercentage>
<ClusterSummary>
<AggregatedReportAssessmentStatus>
<Label>sample string 2</Label>
<StatusType>3</StatusType>
<Count>1</Count>
</AggregatedReportAssessmentStatus>
<AggregatedReportAssessmentStatus>
<Label>sample string 2</Label>
<StatusType>3</StatusType>
<Count>1</Count>
</AggregatedReportAssessmentStatus>
</ClusterSummary>
<Description>sample string 3</Description>
<Groups>
<ReportGroup>
<GroupId>1</GroupId>
<Parents>
<ReportLearningObjectiveParent>
<Description>sample string 3</Description>
<Id>1</Id>
<Title>sample string 2</Title>
</ReportLearningObjectiveParent>
<ReportLearningObjectiveParent>
<Description>sample string 3</Description>
<Id>1</Id>
<Title>sample string 2</Title>
</ReportLearningObjectiveParent>
</Parents>
<ReportGroupItems>
<ReportGroupItem>
<Description>sample string 3</Description>
<LearningObjectiveId>1</LearningObjectiveId>
<Mastered>true</Mastered>
<MasteredDate>2025-06-25T14:40:37Z</MasteredDate>
<Status>
<Label>sample string 1</Label>
<StatusType>2</StatusType>
</Status>
<Title>sample string 2</Title>
</ReportGroupItem>
<ReportGroupItem>
<Description>sample string 3</Description>
<LearningObjectiveId>1</LearningObjectiveId>
<Mastered>true</Mastered>
<MasteredDate>2025-06-25T14:40:37Z</MasteredDate>
<Status>
<Label>sample string 1</Label>
<StatusType>2</StatusType>
</Status>
<Title>sample string 2</Title>
</ReportGroupItem>
</ReportGroupItems>
</ReportGroup>
<ReportGroup>
<GroupId>1</GroupId>
<Parents>
<ReportLearningObjectiveParent>
<Description>sample string 3</Description>
<Id>1</Id>
<Title>sample string 2</Title>
</ReportLearningObjectiveParent>
<ReportLearningObjectiveParent>
<Description>sample string 3</Description>
<Id>1</Id>
<Title>sample string 2</Title>
</ReportLearningObjectiveParent>
</Parents>
<ReportGroupItems>
<ReportGroupItem>
<Description>sample string 3</Description>
<LearningObjectiveId>1</LearningObjectiveId>
<Mastered>true</Mastered>
<MasteredDate>2025-06-25T14:40:37Z</MasteredDate>
<Status>
<Label>sample string 1</Label>
<StatusType>2</StatusType>
</Status>
<Title>sample string 2</Title>
</ReportGroupItem>
<ReportGroupItem>
<Description>sample string 3</Description>
<LearningObjectiveId>1</LearningObjectiveId>
<Mastered>true</Mastered>
<MasteredDate>2025-06-25T14:40:37Z</MasteredDate>
<Status>
<Label>sample string 1</Label>
<StatusType>2</StatusType>
</Status>
<Title>sample string 2</Title>
</ReportGroupItem>
</ReportGroupItems>
</ReportGroup>
</Groups>
<Title>sample string 2</Title>
</ReportCluster>
<ReportCluster>
<ClusterId>1</ClusterId>
<ClusterMasteryPercentage>4.1</ClusterMasteryPercentage>
<ClusterSummary>
<AggregatedReportAssessmentStatus>
<Label>sample string 2</Label>
<StatusType>3</StatusType>
<Count>1</Count>
</AggregatedReportAssessmentStatus>
<AggregatedReportAssessmentStatus>
<Label>sample string 2</Label>
<StatusType>3</StatusType>
<Count>1</Count>
</AggregatedReportAssessmentStatus>
</ClusterSummary>
<Description>sample string 3</Description>
<Groups>
<ReportGroup>
<GroupId>1</GroupId>
<Parents>
<ReportLearningObjectiveParent>
<Description>sample string 3</Description>
<Id>1</Id>
<Title>sample string 2</Title>
</ReportLearningObjectiveParent>
<ReportLearningObjectiveParent>
<Description>sample string 3</Description>
<Id>1</Id>
<Title>sample string 2</Title>
</ReportLearningObjectiveParent>
</Parents>
<ReportGroupItems>
<ReportGroupItem>
<Description>sample string 3</Description>
<LearningObjectiveId>1</LearningObjectiveId>
<Mastered>true</Mastered>
<MasteredDate>2025-06-25T14:40:37Z</MasteredDate>
<Status>
<Label>sample string 1</Label>
<StatusType>2</StatusType>
</Status>
<Title>sample string 2</Title>
</ReportGroupItem>
<ReportGroupItem>
<Description>sample string 3</Description>
<LearningObjectiveId>1</LearningObjectiveId>
<Mastered>true</Mastered>
<MasteredDate>2025-06-25T14:40:37Z</MasteredDate>
<Status>
<Label>sample string 1</Label>
<StatusType>2</StatusType>
</Status>
<Title>sample string 2</Title>
</ReportGroupItem>
</ReportGroupItems>
</ReportGroup>
<ReportGroup>
<GroupId>1</GroupId>
<Parents>
<ReportLearningObjectiveParent>
<Description>sample string 3</Description>
<Id>1</Id>
<Title>sample string 2</Title>
</ReportLearningObjectiveParent>
<ReportLearningObjectiveParent>
<Description>sample string 3</Description>
<Id>1</Id>
<Title>sample string 2</Title>
</ReportLearningObjectiveParent>
</Parents>
<ReportGroupItems>
<ReportGroupItem>
<Description>sample string 3</Description>
<LearningObjectiveId>1</LearningObjectiveId>
<Mastered>true</Mastered>
<MasteredDate>2025-06-25T14:40:37Z</MasteredDate>
<Status>
<Label>sample string 1</Label>
<StatusType>2</StatusType>
</Status>
<Title>sample string 2</Title>
</ReportGroupItem>
<ReportGroupItem>
<Description>sample string 3</Description>
<LearningObjectiveId>1</LearningObjectiveId>
<Mastered>true</Mastered>
<MasteredDate>2025-06-25T14:40:37Z</MasteredDate>
<Status>
<Label>sample string 1</Label>
<StatusType>2</StatusType>
</Status>
<Title>sample string 2</Title>
</ReportGroupItem>
</ReportGroupItems>
</ReportGroup>
</Groups>
<Title>sample string 2</Title>
</ReportCluster>
</Clusters>
<FullReportUrl>sample string 4</FullReportUrl>
<SubjectId>1</SubjectId>
<SubjectMasteryPercentage>2.1</SubjectMasteryPercentage>
<SubjectSummary>
<AggregatedReportAssessmentStatus>
<Label>sample string 2</Label>
<StatusType>3</StatusType>
<Count>1</Count>
</AggregatedReportAssessmentStatus>
<AggregatedReportAssessmentStatus>
<Label>sample string 2</Label>
<StatusType>3</StatusType>
<Count>1</Count>
</AggregatedReportAssessmentStatus>
</SubjectSummary>
<UseMastery>true</UseMastery>
</AggregatedReport>