GET centers/{centerId}/students?sortInfo.SortBy={sortInfo.SortBy}&sortInfo.Direction={sortInfo.Direction}&paginationInfo.Count={paginationInfo.Count}&paginationInfo.Offset={paginationInfo.Offset}&searchPhrase={searchPhrase}

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

SortBy

string

None.

Direction

PearsonEnglish.LearningServices.Core.Models.Enums.Direction

None.

Count

integer

None.

Offset

integer

None.

ContractStatuses

Collection of PearsonEnglish.LearningServices.Core.Models.Enums.ContractStatuses

None.

RiskLevels

Collection of PearsonEnglish.LearningServices.Core.Models.Enums.StudentRiskLevel

None.

MyStudentsOnly

boolean

None.

EncounterFilterOption

Collection of PearsonEnglish.LearningServices.Core.Models.Enums.EncounterFilterOptions

None.

TeacherUserName

string

None.

CourseStatuses

Collection of PearsonEnglish.LearningServices.Core.Models.Enums.ContractStatuses

None.

RegistrationStatuses

Collection of PearsonEnglish.LearningServices.Core.Models.Enums.ContractStatuses

None.

ClassAccessTypes

Collection of PearsonEnglish.LearningServices.Core.Models.Enums.ClassAccessTypes

None.

ServiceTypes

Collection of PearsonEnglish.LearningServices.Core.Models.Enums.StudentListServiceType

None.

Unit

integer

None.

searchPhrase

string

Default value is

Body Parameters

None.

Response Information

Resource Description

PagedCollectionOfPearsonEnglish.LearningServices.Core.Models.Views.StudentListItemViewModel
NameDescriptionTypeAdditional information
TotalItemCount

integer

None.

Elements

Collection of PearsonEnglish.LearningServices.Core.Models.Views.StudentListItemViewModel

None.

Response Formats

application/json, text/json

Sample:

Sample not available.