GET students/{userIdentifier}/categoryDescendents/{categoryId}/results

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 a student who is assigned to content item result specified by "contentItemResultId" uri parameter or by content of request. Authenticated user is a staff member and is assigned to the same center as a user who matches a student who is assigned to content item result specified by "contentItemResultId" uri parameter or by content of request.
  • Authenticated user who is either StaffMember, Student

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userIdentifier

PearsonEnglish.LearningServices.Business.Helpers.UserIdentifier

Required

categoryId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

PearsonEnglish.LearningServices.Core.Models.ContentItemResult
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

RegistrationId

globally unique identifier

None.

StudentId

globally unique identifier

None.

ContentItemId

globally unique identifier

None.

ContentItemResultTypeId

PearsonEnglish.LearningServices.Core.Models.Enums.ContentItemResultTypes

None.

Score

decimal number

None.

DateStarted

date

None.

DateCompleted

date

None.

Duration

integer

None.

Comment

string

None.

RefClassId

string

None.

TeacherId

globally unique identifier

None.

StudyMode

PearsonEnglish.LearningServices.Core.Models.Enums.StudyModes

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "38a316a4-22e5-451d-bf41-2ecd3463b0c5",
  "RegistrationId": "6ab35ca4-1b50-4926-9098-af7c37a25e68",
  "StudentId": "5a4a1182-1522-476b-92ef-080998366a89",
  "ContentItemId": "de84c450-d84f-48a2-af4c-a6908cdade4a",
  "ContentItemResultTypeId": 1,
  "Score": 1.0,
  "DateStarted": "2024-10-05T09:19:51.682767+00:00",
  "DateCompleted": "2024-10-05T09:19:51.682767+00:00",
  "Duration": 1,
  "Comment": "sample string 5",
  "RefClassId": "sample string 6",
  "TeacherId": "e0f080d7-6cb0-4dbc-9e32-3a7cac40def7",
  "StudyMode": 0
}