GET openapi/classes/{refClassId}/details
Authorization
Access to this endpoint is granted if all following conditions are true:
- Authenticated territory has access to center which matches identifier given in "centerId" uri parameter.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| refClassId | string |
Required |
Body Parameters
None.
Response Information
Resource Description
PearsonEnglish.LearningServices.Wse.Models.Views.ClassDetailsViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| BookedStudents | Collection of PearsonEnglish.LearningServices.Wse.Models.Views.StudentUnitAggregateViewModel |
None. |
|
| StandbyStudents | Collection of PearsonEnglish.LearningServices.Wse.Models.Views.StudentUnitAggregateViewModel |
None. |
|
| TeacherFirstName | string |
None. |
|
| TeacherLastName | string |
None. |
|
| CenterName | string |
None. |
|
| IsZoomEnabledCenter | boolean |
None. |
|
| Id | globally unique identifier |
None. |
|
| ClassId | string |
None. |
|
| ClassCode | string |
None. |
|
| ClassType | integer |
None. |
|
| NumberOfSeats | integer |
None. |
|
| NumberOfStudents | integer |
None. |
|
| IsComplete | boolean |
None. |
|
| NumberOfStudentsOnStandbyList | integer |
None. |
|
| MaxNumberOfStudentsOnStandbyList | integer |
None. |
|
| IsClosed | boolean |
None. |
|
| IsOnline | boolean |
None. |
|
| StartDate | date |
None. |
|
| Duration | integer |
None. |
|
| Categories | Collection of PearsonEnglish.LearningServices.Core.Models.Views.CategoryViewModel |
None. |
|
| CategoriesAbbreviations | string |
None. |
|
| ClassDescription | string |
None. |
|
| CompanyId | globally unique identifier |
None. |
|
| AcceptsStandby | boolean |
None. |
|
| TeacherId | globally unique identifier |
None. |
|
| TeacherSsdsId | string |
None. |
|
| IsVisibleInGroup | boolean |
None. |
|
| IsB2B | boolean |
None. |
|
| IsStandbyListFull | boolean |
None. |
|
| CenterId | globally unique identifier |
None. |
|
| IsTechnologyEnabledCenter | boolean |
None. |
|
| IsScheduledInOnlineCenter | boolean |
None. |
|
| IsTeen | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"BookedStudents": [
{
"Student": {
"StudentCode": "sample string 1",
"CenterId": "sample string 2",
"CenterName": "sample string 3",
"UserId": "3b06ff72-0d42-4c0b-bc3c-0fdd7900d816",
"tempisNewStudent": true,
"LastName": "sample string 6",
"FirstName": "sample string 7",
"SsdsId": "sample string 8",
"StudentId": 9,
"PhotoUris": {
"Small": "sample string 1"
},
"SocialNetworkAddress1": "sample string 10",
"SocialNetworkAddress2": "sample string 11",
"SocialNetworkAddress3": "sample string 12",
"SocialNetworkAddress4": "sample string 13",
"SocialNetwork1": "sample string 14",
"SocialNetwork2": "sample string 15",
"SocialNetwork3": "sample string 16",
"SocialNetwork4": "sample string 17",
"Email": "sample string 18",
"MobileTelephone": "sample string 19",
"HomeTelephone": "sample string 20",
"WorkTelephone": "sample string 21",
"PreferredContactMethod": 0,
"PreferredSocialNetworkId": "d0f07f5c-4566-4bc4-a4f8-0a9a3b4ab18b",
"PreferredSocialNetworkName": "sample string 22",
"PreferredSocialNetworkAddress": "sample string 23"
},
"CurrentUnitNumber": "sample string 1"
},
{
"Student": {
"StudentCode": "sample string 1",
"CenterId": "sample string 2",
"CenterName": "sample string 3",
"UserId": "3b06ff72-0d42-4c0b-bc3c-0fdd7900d816",
"tempisNewStudent": true,
"LastName": "sample string 6",
"FirstName": "sample string 7",
"SsdsId": "sample string 8",
"StudentId": 9,
"PhotoUris": {
"Small": "sample string 1"
},
"SocialNetworkAddress1": "sample string 10",
"SocialNetworkAddress2": "sample string 11",
"SocialNetworkAddress3": "sample string 12",
"SocialNetworkAddress4": "sample string 13",
"SocialNetwork1": "sample string 14",
"SocialNetwork2": "sample string 15",
"SocialNetwork3": "sample string 16",
"SocialNetwork4": "sample string 17",
"Email": "sample string 18",
"MobileTelephone": "sample string 19",
"HomeTelephone": "sample string 20",
"WorkTelephone": "sample string 21",
"PreferredContactMethod": 0,
"PreferredSocialNetworkId": "d0f07f5c-4566-4bc4-a4f8-0a9a3b4ab18b",
"PreferredSocialNetworkName": "sample string 22",
"PreferredSocialNetworkAddress": "sample string 23"
},
"CurrentUnitNumber": "sample string 1"
}
],
"StandbyStudents": [
{
"Student": {
"StudentCode": "sample string 1",
"CenterId": "sample string 2",
"CenterName": "sample string 3",
"UserId": "3b06ff72-0d42-4c0b-bc3c-0fdd7900d816",
"tempisNewStudent": true,
"LastName": "sample string 6",
"FirstName": "sample string 7",
"SsdsId": "sample string 8",
"StudentId": 9,
"PhotoUris": {
"Small": "sample string 1"
},
"SocialNetworkAddress1": "sample string 10",
"SocialNetworkAddress2": "sample string 11",
"SocialNetworkAddress3": "sample string 12",
"SocialNetworkAddress4": "sample string 13",
"SocialNetwork1": "sample string 14",
"SocialNetwork2": "sample string 15",
"SocialNetwork3": "sample string 16",
"SocialNetwork4": "sample string 17",
"Email": "sample string 18",
"MobileTelephone": "sample string 19",
"HomeTelephone": "sample string 20",
"WorkTelephone": "sample string 21",
"PreferredContactMethod": 0,
"PreferredSocialNetworkId": "d0f07f5c-4566-4bc4-a4f8-0a9a3b4ab18b",
"PreferredSocialNetworkName": "sample string 22",
"PreferredSocialNetworkAddress": "sample string 23"
},
"CurrentUnitNumber": "sample string 1"
},
{
"Student": {
"StudentCode": "sample string 1",
"CenterId": "sample string 2",
"CenterName": "sample string 3",
"UserId": "3b06ff72-0d42-4c0b-bc3c-0fdd7900d816",
"tempisNewStudent": true,
"LastName": "sample string 6",
"FirstName": "sample string 7",
"SsdsId": "sample string 8",
"StudentId": 9,
"PhotoUris": {
"Small": "sample string 1"
},
"SocialNetworkAddress1": "sample string 10",
"SocialNetworkAddress2": "sample string 11",
"SocialNetworkAddress3": "sample string 12",
"SocialNetworkAddress4": "sample string 13",
"SocialNetwork1": "sample string 14",
"SocialNetwork2": "sample string 15",
"SocialNetwork3": "sample string 16",
"SocialNetwork4": "sample string 17",
"Email": "sample string 18",
"MobileTelephone": "sample string 19",
"HomeTelephone": "sample string 20",
"WorkTelephone": "sample string 21",
"PreferredContactMethod": 0,
"PreferredSocialNetworkId": "d0f07f5c-4566-4bc4-a4f8-0a9a3b4ab18b",
"PreferredSocialNetworkName": "sample string 22",
"PreferredSocialNetworkAddress": "sample string 23"
},
"CurrentUnitNumber": "sample string 1"
}
],
"TeacherFirstName": "sample string 1",
"TeacherLastName": "sample string 2",
"CenterName": "sample string 3",
"IsZoomEnabledCenter": true,
"Id": "8e590d47-e88f-42dd-ac53-b86a1a046d1e",
"ClassId": "sample string 5",
"ClassCode": "sample string 6",
"ClassType": 7,
"NumberOfSeats": 8,
"NumberOfStudents": 9,
"IsComplete": true,
"NumberOfStudentsOnStandbyList": 1,
"MaxNumberOfStudentsOnStandbyList": 10,
"IsClosed": true,
"IsOnline": true,
"StartDate": "2025-10-25T07:38:55.0049217+00:00",
"Duration": 12,
"Categories": [
{
"Id": "a97367be-c2d4-431a-a837-d75cdd30735c",
"Type": "sample string 2",
"Sequence": 1,
"Path": "sample string 3",
"Attributes": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"ChildCategories": []
},
{
"Id": "a97367be-c2d4-431a-a837-d75cdd30735c",
"Type": "sample string 2",
"Sequence": 1,
"Path": "sample string 3",
"Attributes": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"ChildCategories": []
}
],
"CategoriesAbbreviations": "sample string 13",
"ClassDescription": "sample string 14",
"CompanyId": "1ee8366d-6966-43a4-82bf-4993ff8cf47c",
"AcceptsStandby": true,
"TeacherId": "f58d37ed-fee8-4613-8092-461cfa27d764",
"TeacherSsdsId": "sample string 17",
"IsVisibleInGroup": true,
"IsB2B": true,
"IsStandbyListFull": false,
"CenterId": "0c64f000-5039-4aab-8974-1691f38acf96",
"IsTechnologyEnabledCenter": true,
"IsScheduledInOnlineCenter": true,
"IsTeen": true
}