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": "3eb0d381-904f-43a9-839a-89ff0f28ce3b",
  "RegistrationId": "bf454e90-5d8a-4035-8115-ebd6e26f6230",
  "StudentId": "1812cbc9-cf11-426a-b272-9b13ada7f4ce",
  "ContentItemId": "470868a9-a072-446a-8b81-3e7dc28156e0",
  "ContentItemResultTypeId": 1,
  "Score": 1.0,
  "DateStarted": "2024-10-05T09:20:25.4184911+00:00",
  "DateCompleted": "2024-10-05T09:20:25.4184911+00:00",
  "Duration": 1,
  "Comment": "sample string 5",
  "RefClassId": "sample string 6",
  "TeacherId": "687bb935-3d1f-4f21-b2f8-7c73af170f98",
  "StudyMode": 0
}