GET classes/{ssdsClassId}/details

Authorization

Access to this endpoint is granted if all following conditions are true:

Authenticated user who is either StaffMember
Authenticated user belongs to center which matches a center that is assigned to material specified by "ssdsClassId" uri parameter or by content of request.

Request Information

URI Parameters

Name	Description	Type	Additional information
ssdsClassId		string	Required

Body Parameters

None.

Response Information

Resource Description

PearsonEnglish.LearningServices.Wse.Models.Views.ClassDetailsViewModel

Name	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": "2359c8a2-dcb3-481c-a853-2c937a0b2400",
        "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": "ec4b9025-b1de-4832-a843-0dafbe7b310e",
        "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": "2359c8a2-dcb3-481c-a853-2c937a0b2400",
        "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": "ec4b9025-b1de-4832-a843-0dafbe7b310e",
        "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": "2359c8a2-dcb3-481c-a853-2c937a0b2400",
        "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": "ec4b9025-b1de-4832-a843-0dafbe7b310e",
        "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": "2359c8a2-dcb3-481c-a853-2c937a0b2400",
        "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": "ec4b9025-b1de-4832-a843-0dafbe7b310e",
        "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": "0991b031-3810-4775-83b7-5cd6ed573855",
  "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": "2024-12-20T14:38:14.3850733+00:00",
  "Duration": 12,
  "Categories": [
    {
      "Id": "9470c06b-a1de-4f5f-94e0-41137dabf62f",
      "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": "9470c06b-a1de-4f5f-94e0-41137dabf62f",
      "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": "f22bb94c-f722-46eb-8936-f91911084206",
  "AcceptsStandby": true,
  "TeacherId": "7e24343d-e749-4313-839d-3044b28dc6c1",
  "TeacherSsdsId": "sample string 17",
  "IsVisibleInGroup": true,
  "IsB2B": true,
  "IsStandbyListFull": false,
  "CenterId": "b220ea37-fe32-4589-bf11-137bf218e929",
  "IsTechnologyEnabledCenter": true,
  "IsScheduledInOnlineCenter": true,
  "IsTeen": true
}