GET users/{userIdentifier}/encounters

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

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "UnitNumber": 1,
    "Id": "e8374f8c-33c3-4f7f-8683-b5301f19c22e",
    "DateTime": "2024-10-05T09:22:14.7104723+00:00",
    "EndDate": "2024-10-05T09:22:14.7104723+00:00",
    "Duration": 4,
    "Status": "Available",
    "IsOnline": true,
    "CenterId": "8c234177-d5c1-48e0-8aa2-c6871067e934",
    "CenterName": "sample string 7",
    "CenterReferenceId": "sample string 8"
  },
  {
    "UnitNumber": 1,
    "Id": "e8374f8c-33c3-4f7f-8683-b5301f19c22e",
    "DateTime": "2024-10-05T09:22:14.7104723+00:00",
    "EndDate": "2024-10-05T09:22:14.7104723+00:00",
    "Duration": 4,
    "Status": "Available",
    "IsOnline": true,
    "CenterId": "8c234177-d5c1-48e0-8aa2-c6871067e934",
    "CenterName": "sample string 7",
    "CenterReferenceId": "sample string 8"
  }
]