GET centers/{centerId}/schedule?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
Name | Description | Type | Additional information |
---|---|---|---|
centerId | globally unique identifier |
Required |
|
startDate | date |
None. |
|
includeOnlineCenterClasses | boolean |
Default value is True |
|
includeCrossCenterGroupClasses | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Collection of PearsonEnglish.LearningServices.Wse.Models.Views.ScheduledClassViewModelName | Description | Type | Additional 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": "7256d0aa-e69a-4878-8cd7-407e8a870bb0", "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-12-20T13:58:28.226673+00:00", "Duration": 9, "Categories": [ { "Id": "85a80e5d-6dfa-4707-84bc-fc7a88eeca35", "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": "85a80e5d-6dfa-4707-84bc-fc7a88eeca35", "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": "2ae63b23-ca31-4f6b-9534-742974608d1f", "AcceptsStandby": true, "TeacherId": "ecaf3739-93c7-44e4-bd40-6dfe700d995c", "TeacherSsdsId": "sample string 14", "IsVisibleInGroup": true, "IsB2B": true, "IsStandbyListFull": false, "CenterId": "96523c7e-65b6-492f-b35e-cb6e50ea33e2", "CenterName": "sample string 17", "IsTechnologyEnabledCenter": true, "IsScheduledInOnlineCenter": true, "IsTeen": true }, { "Id": "7256d0aa-e69a-4878-8cd7-407e8a870bb0", "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-12-20T13:58:28.226673+00:00", "Duration": 9, "Categories": [ { "Id": "85a80e5d-6dfa-4707-84bc-fc7a88eeca35", "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": "85a80e5d-6dfa-4707-84bc-fc7a88eeca35", "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": "2ae63b23-ca31-4f6b-9534-742974608d1f", "AcceptsStandby": true, "TeacherId": "ecaf3739-93c7-44e4-bd40-6dfe700d995c", "TeacherSsdsId": "sample string 14", "IsVisibleInGroup": true, "IsB2B": true, "IsStandbyListFull": false, "CenterId": "96523c7e-65b6-492f-b35e-cb6e50ea33e2", "CenterName": "sample string 17", "IsTechnologyEnabledCenter": true, "IsScheduledInOnlineCenter": true, "IsTeen": true } ]