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

Name	Description	Type	Additional 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

Name	Type	Additional 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": "156c54ad-0c06-4123-8672-23a7ba721e60",
    "DateTime": "2024-10-05T09:27:22.4882301+00:00",
    "EndDate": "2024-10-05T09:27:22.4882301+00:00",
    "Duration": 6,
    "Status": "Available",
    "IsOnline": true,
    "CenterId": "41f5aaf9-8534-4e9b-96ed-ac607b6050f9",
    "CenterName": "sample string 9",
    "CenterReferenceId": "sample string 10"
  },
  {
    "Categories": "sample string 1",
    "Description": "sample string 2",
    "Id": "156c54ad-0c06-4123-8672-23a7ba721e60",
    "DateTime": "2024-10-05T09:27:22.4882301+00:00",
    "EndDate": "2024-10-05T09:27:22.4882301+00:00",
    "Duration": 6,
    "Status": "Available",
    "IsOnline": true,
    "CenterId": "41f5aaf9-8534-4e9b-96ed-ac607b6050f9",
    "CenterName": "sample string 9",
    "CenterReferenceId": "sample string 10"
  }
]