GET api/Class?ssdsClassId={ssdsClassId}&source={source}
Authorization
Access to this endpoint is public.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
ssdsClassId | string |
Required |
|
source | PearsonEnglish.LearningServices.Core.Models.Enums.ApiCallerSource |
Required |
Body Parameters
None.
Response Information
Resource Description
PearsonEnglish.LearningServices.Wse.Models.Views.ClassDetailsViewModelName | 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": "779d6933-6fe9-439b-b44a-33f2602bfe41", "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": "e6a3cd94-4879-4260-9d1c-31fff62296ed", "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": "779d6933-6fe9-439b-b44a-33f2602bfe41", "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": "e6a3cd94-4879-4260-9d1c-31fff62296ed", "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": "779d6933-6fe9-439b-b44a-33f2602bfe41", "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": "e6a3cd94-4879-4260-9d1c-31fff62296ed", "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": "779d6933-6fe9-439b-b44a-33f2602bfe41", "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": "e6a3cd94-4879-4260-9d1c-31fff62296ed", "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": "2ddef083-417c-4857-9dc1-ae5d600668f4", "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-09-01T01:01:10.2039052+00:00", "Duration": 12, "Categories": [ { "Id": "e43b32e3-cf85-488e-9f34-5f0460c08c3e", "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": "e43b32e3-cf85-488e-9f34-5f0460c08c3e", "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": "f4a1a80a-4b7e-48f9-ba5c-11ab1b658a11", "AcceptsStandby": true, "TeacherId": "7d729014-48ef-4d6a-aa53-a9755d20ef71", "TeacherSsdsId": "sample string 17", "IsVisibleInGroup": true, "IsB2B": true, "IsStandbyListFull": false, "CenterId": "4b8916e4-b6a6-44e2-88a3-fa0d051ca85e", "IsTechnologyEnabledCenter": true, "IsScheduledInOnlineCenter": true, "IsTeen": true }