GET centers/{centerId}/schedule/weekly?startDate={startDate}&includeOnlineCenterClasses={includeOnlineCenterClasses}&includeCrossCenterGroupClasses={includeCrossCenterGroupClasses}

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 identifier given in "centerId" uri parameter.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
centerId

globally unique identifier

Required

startDate

date

Required

includeOnlineCenterClasses

boolean

Required

includeCrossCenterGroupClasses

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of PearsonEnglish.LearningServices.Wse.Models.Views.ScheduledClassViewModel
NameDescriptionTypeAdditional information
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.

CenterName

string

None.

IsTechnologyEnabledCenter

boolean

None.

IsScheduledInOnlineCenter

boolean

None.

IsTeen

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": "b2a54bc9-ba6e-4903-a1f1-227c32d078b5",
    "ClassId": "sample string 2",
    "ClassCode": "sample string 3",
    "ClassType": 4,
    "NumberOfSeats": 5,
    "NumberOfStudents": 6,
    "IsComplete": true,
    "NumberOfStudentsOnStandbyList": 1,
    "MaxNumberOfStudentsOnStandbyList": 7,
    "IsClosed": true,
    "IsOnline": true,
    "StartDate": "2024-10-05T09:27:57.2670697+00:00",
    "Duration": 9,
    "Categories": [
      {
        "Id": "074cc852-50d1-4a20-9017-7a5c1b2a3d40",
        "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": "074cc852-50d1-4a20-9017-7a5c1b2a3d40",
        "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 10",
    "ClassDescription": "sample string 11",
    "CompanyId": "9351a4d0-6683-4b1c-a8a1-2eed6a272059",
    "AcceptsStandby": true,
    "TeacherId": "ee380551-0b2e-4c16-9d38-395737f988a6",
    "TeacherSsdsId": "sample string 14",
    "IsVisibleInGroup": true,
    "IsB2B": true,
    "IsStandbyListFull": false,
    "CenterId": "7428abb1-6d36-4663-a7e3-8f46bf05da64",
    "CenterName": "sample string 17",
    "IsTechnologyEnabledCenter": true,
    "IsScheduledInOnlineCenter": true,
    "IsTeen": true
  },
  {
    "Id": "b2a54bc9-ba6e-4903-a1f1-227c32d078b5",
    "ClassId": "sample string 2",
    "ClassCode": "sample string 3",
    "ClassType": 4,
    "NumberOfSeats": 5,
    "NumberOfStudents": 6,
    "IsComplete": true,
    "NumberOfStudentsOnStandbyList": 1,
    "MaxNumberOfStudentsOnStandbyList": 7,
    "IsClosed": true,
    "IsOnline": true,
    "StartDate": "2024-10-05T09:27:57.2670697+00:00",
    "Duration": 9,
    "Categories": [
      {
        "Id": "074cc852-50d1-4a20-9017-7a5c1b2a3d40",
        "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": "074cc852-50d1-4a20-9017-7a5c1b2a3d40",
        "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 10",
    "ClassDescription": "sample string 11",
    "CompanyId": "9351a4d0-6683-4b1c-a8a1-2eed6a272059",
    "AcceptsStandby": true,
    "TeacherId": "ee380551-0b2e-4c16-9d38-395737f988a6",
    "TeacherSsdsId": "sample string 14",
    "IsVisibleInGroup": true,
    "IsB2B": true,
    "IsStandbyListFull": false,
    "CenterId": "7428abb1-6d36-4663-a7e3-8f46bf05da64",
    "CenterName": "sample string 17",
    "IsTechnologyEnabledCenter": true,
    "IsScheduledInOnlineCenter": true,
    "IsTeen": true
  }
]