GET users/{userIdentifier}/nonEncounters/available?classType={classType}

Authorization

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

  • Authenticated user passes at least one of the following conditions: Authenticated user matches identifier given in "userIdentifier, studentIdentifier" uri parameter. Authenticated user is a staff member and is assigned to the same center as a user who matches identifier given in "userIdentifier, studentIdentifier" uri parameter.
  • Authenticated user who is either StaffMember, Student

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userIdentifier

PearsonEnglish.LearningServices.Business.Helpers.UserIdentifier

Required

classType

PearsonEnglish.LearningServices.Core.Models.Enums.ClassTypes

Required

Body Parameters

None.

Response Information

Resource Description

Collection of PearsonEnglish.LearningServices.Wse.Models.AvailableNonEncounter
NameDescriptionTypeAdditional information
Categories

string

None.

Description

string

None.

Id

globally unique identifier

None.

DateTime

date

None.

EndDate

date

None.

Duration

integer

None.

Status

PearsonEnglish.LearningServices.Wse.Models.AvailableClassStatus

None.

IsOnline

boolean

None.

CenterId

globally unique identifier

None.

CenterName

string

None.

CenterReferenceId

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Categories": "sample string 1",
    "Description": "sample string 2",
    "Id": "f4ac9245-0095-496d-8a2e-86d3a8437b64",
    "DateTime": "2025-08-29T04:48:45.3089147+00:00",
    "EndDate": "2025-08-29T04:48:45.3089147+00:00",
    "Duration": 6,
    "Status": "Available",
    "IsOnline": true,
    "CenterId": "3be83f03-9e1c-46f6-9d59-bb6f0f5c87b4",
    "CenterName": "sample string 9",
    "CenterReferenceId": "sample string 10"
  },
  {
    "Categories": "sample string 1",
    "Description": "sample string 2",
    "Id": "f4ac9245-0095-496d-8a2e-86d3a8437b64",
    "DateTime": "2025-08-29T04:48:45.3089147+00:00",
    "EndDate": "2025-08-29T04:48:45.3089147+00:00",
    "Duration": 6,
    "Status": "Available",
    "IsOnline": true,
    "CenterId": "3be83f03-9e1c-46f6-9d59-bb6f0f5c87b4",
    "CenterName": "sample string 9",
    "CenterReferenceId": "sample string 10"
  }
]