GET users/{userIdentifier}/encounters/available

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

Body Parameters

None.

Response Information

Resource Description

Collection of PearsonEnglish.LearningServices.Wse.Models.AvailableEncounter
NameDescriptionTypeAdditional information
UnitNumber

integer

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:
[
  {
    "UnitNumber": 1,
    "Id": "39214633-8008-42ee-853f-8d8b04d4f999",
    "DateTime": "2025-11-08T21:21:44.0664027+00:00",
    "EndDate": "2025-11-08T21:21:44.0664027+00:00",
    "Duration": 4,
    "Status": "Available",
    "IsOnline": true,
    "CenterId": "3578b651-7bac-4ec7-b323-b1ae5a8834ff",
    "CenterName": "sample string 7",
    "CenterReferenceId": "sample string 8"
  },
  {
    "UnitNumber": 1,
    "Id": "39214633-8008-42ee-853f-8d8b04d4f999",
    "DateTime": "2025-11-08T21:21:44.0664027+00:00",
    "EndDate": "2025-11-08T21:21:44.0664027+00:00",
    "Duration": 4,
    "Status": "Available",
    "IsOnline": true,
    "CenterId": "3578b651-7bac-4ec7-b323-b1ae5a8834ff",
    "CenterName": "sample string 7",
    "CenterReferenceId": "sample string 8"
  }
]