GET students/{userIdentifier}/classCounter
Authorization
Access to this endpoint is granted if all following conditions are true:
- Authenticated user who is either StaffMember, Student
- 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 matches identifier given in "userIdentifier, studentIdentifier" uri parameter.
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.Core.Models.Views.StudentClassCounterViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| StudentSsdsId | string |
None. |
|
| CurrentLevel | string |
None. |
|
| MaximumCCSCPerLevel | integer |
None. |
|
| CurrentLevelCCorSCAttended | integer |
None. |
|
| PreviousLevelCCorSCAttended | integer |
None. |
|
| IsCarryOverEnabled | boolean |
None. |
|
| AvailableCCorSCPerLevel | integer |
None. |
|
| HasPreviousLevelInContract | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"StudentSsdsId": "sample string 1",
"CurrentLevel": "sample string 2",
"MaximumCCSCPerLevel": 3,
"CurrentLevelCCorSCAttended": 4,
"PreviousLevelCCorSCAttended": 1,
"IsCarryOverEnabled": true,
"AvailableCCorSCPerLevel": 6,
"HasPreviousLevelInContract": true
}