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

Name	Description	Type	Additional information
userIdentifier		PearsonEnglish.LearningServices.Business.Helpers.UserIdentifier	Required

Body Parameters

None.

Response Information

Resource Description

Collection of PearsonEnglish.LearningServices.Wse.Models.AvailableEncounter

Name	Type	Additional 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": "09671915-6c93-496d-97aa-d3817cba0904",
    "DateTime": "2024-10-05T09:16:49.8133185+00:00",
    "EndDate": "2024-10-05T09:16:49.8133185+00:00",
    "Duration": 4,
    "Status": "Available",
    "IsOnline": true,
    "CenterId": "3e66ff41-fc18-4b17-b424-df03e3023643",
    "CenterName": "sample string 7",
    "CenterReferenceId": "sample string 8"
  },
  {
    "UnitNumber": 1,
    "Id": "09671915-6c93-496d-97aa-d3817cba0904",
    "DateTime": "2024-10-05T09:16:49.8133185+00:00",
    "EndDate": "2024-10-05T09:16:49.8133185+00:00",
    "Duration": 4,
    "Status": "Available",
    "IsOnline": true,
    "CenterId": "3e66ff41-fc18-4b17-b424-df03e3023643",
    "CenterName": "sample string 7",
    "CenterReferenceId": "sample string 8"
  }
]