GET users/{userIdentifier}/progress
Authorization
Access to this endpoint is granted if all following conditions are true:
- Authenticated user passes at least one of the following conditions: Authenticated user matches identifier given in "userIdentifier, studentIdentifier" uri parameter. Authenticated user is a staff member and is assigned to the same center as a user who matches identifier given in "userIdentifier, studentIdentifier" uri parameter. Authenticated user is a staff member and is assigned to the online center as a user who matches identifier given in "userIdentifier, studentIdentifier" uri parameter. Authenticated user matches identifier given in "userIdentifier, studentIdentifier" uri parameter.
- Authenticated user who is either StaffMember, Student, ProspectWithTrial
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| userIdentifier | PearsonEnglish.LearningServices.Business.Helpers.UserIdentifier |
Required |
Body Parameters
None.
Response Information
Resource Description
PearsonEnglish.LearningServices.Wse.Models.Views.UserProgressViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| RiskProbability | decimal number |
None. |
|
| ActualProgressRatio | decimal number |
None. |
|
| EndDate | date |
None. |
|
| IdealProgressRatio | decimal number |
None. |
|
| IdealUnit | PearsonEnglish.LearningServices.Core.Models.Views.CategoryWithNumberViewModel |
None. |
|
| IdealUnitNumber | decimal number |
None. |
|
| LinearProgressRatio | decimal number |
None. |
|
| MonthsLeft | decimal number |
None. |
|
| MonthsPassed | decimal number |
None. |
|
| OnTrack | boolean |
None. |
|
| StartDate | date |
None. |
|
| TotalContractedUnits | integer |
None. |
|
| TotalDoneUnits | decimal number |
None. |
|
| TotalUnitsLeft | decimal number |
None. |
|
| ContractedLevels | Collection of PearsonEnglish.LearningServices.Core.Models.Views.CategoryWithNumberViewModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"RiskProbability": 1.0,
"ActualProgressRatio": 1.1,
"EndDate": "2025-10-24T19:30:10.4138552+00:00",
"IdealProgressRatio": 3.1,
"IdealUnit": {
"Id": "a1cde003-b301-4d00-a7db-e255bb8f6107",
"Attributes": {
"Number": "sample string 1"
},
"ChildCategories": []
},
"IdealUnitNumber": 4.1,
"LinearProgressRatio": 5.1,
"MonthsLeft": 6.1,
"MonthsPassed": 7.1,
"OnTrack": true,
"StartDate": "2025-10-24T19:30:10.4138552+00:00",
"TotalContractedUnits": 10,
"TotalDoneUnits": 11.1,
"TotalUnitsLeft": 12.1,
"ContractedLevels": [
{
"Id": "a1cde003-b301-4d00-a7db-e255bb8f6107",
"Attributes": {
"Number": "sample string 1"
},
"ChildCategories": []
},
{
"Id": "a1cde003-b301-4d00-a7db-e255bb8f6107",
"Attributes": {
"Number": "sample string 1"
},
"ChildCategories": []
}
]
}