GET students/{studentIdentifier}/unitssummaries?direction={direction}&Count={Count}&Offset={Offset}

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 "studentIdentifier" uri parameter. Authenticated user is a staff member and is assigned to the same center as a user who matches identifier given in "studentIdentifier" uri parameter. Authenticated user is a staff member and is assigned to the online center as a user who matches identifier given in "studentIdentifier" uri parameter. Authenticated user matches identifier given in "studentIdentifier" uri parameter.
Authenticated user who is either StaffMember, Student, ProspectWithTrial

Request Information

URI Parameters

Name	Type	Additional information
studentIdentifier	PearsonEnglish.LearningServices.Business.Helpers.UserIdentifier	Required
direction	PearsonEnglish.LearningServices.Core.Models.Enums.Direction	Default value is DESC
Count	integer	None.
Offset	integer	None.

Body Parameters

None.

Response Information

Resource Description

PagedResultOfIEnumerableOfPearsonEnglish.LearningServices.Wse.Models.Views.Gradebook.UnitSummaryViewModel

Name	Description	Type	Additional information
TotalItemCount		integer	None.
Elements		Collection of PearsonEnglish.LearningServices.Wse.Models.Views.Gradebook.UnitSummaryViewModel	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalItemCount": 1,
  "Elements": [
    {
      "UnitId": "b9e7bf0f-4acf-43d3-b7f5-45d76cfa09c7",
      "UnitNumber": "sample string 2",
      "ActivitySummary": {
        "LastUpdate": "2024-12-20T14:28:43.7233688+00:00",
        "Duration": 2,
        "Progress": 3,
        "Overall": 1,
        "Skills": [
          {
            "Name": "sample string 1",
            "Abbreviation": "sample string 2",
            "Score": 3.1
          },
          {
            "Name": "sample string 1",
            "Abbreviation": "sample string 2",
            "Score": 3.1
          }
        ]
      },
      "WorkbookSummary": null,
      "EncounterSummary": {
        "TeacherFullName": "sample string 1",
        "Result": "sample string 2",
        "Feedback": "sample string 3",
        "Score": 1.0,
        "DateCompletion": "2024-12-20T14:28:43.7233688+00:00",
        "EncounterPartialResults": [
          {
            "SkillName": "sample string 1",
            "Result": 2
          },
          {
            "SkillName": "sample string 1",
            "Result": 2
          }
        ]
      },
      "Skills": [
        {
          "Name": "sample string 1",
          "Abbreviation": "sample string 2",
          "Score": 3.1
        },
        {
          "Name": "sample string 1",
          "Abbreviation": "sample string 2",
          "Score": 3.1
        }
      ]
    },
    {
      "UnitId": "b9e7bf0f-4acf-43d3-b7f5-45d76cfa09c7",
      "UnitNumber": "sample string 2",
      "ActivitySummary": {
        "LastUpdate": "2024-12-20T14:28:43.7233688+00:00",
        "Duration": 2,
        "Progress": 3,
        "Overall": 1,
        "Skills": [
          {
            "Name": "sample string 1",
            "Abbreviation": "sample string 2",
            "Score": 3.1
          },
          {
            "Name": "sample string 1",
            "Abbreviation": "sample string 2",
            "Score": 3.1
          }
        ]
      },
      "WorkbookSummary": null,
      "EncounterSummary": {
        "TeacherFullName": "sample string 1",
        "Result": "sample string 2",
        "Feedback": "sample string 3",
        "Score": 1.0,
        "DateCompletion": "2024-12-20T14:28:43.7233688+00:00",
        "EncounterPartialResults": [
          {
            "SkillName": "sample string 1",
            "Result": 2
          },
          {
            "SkillName": "sample string 1",
            "Result": 2
          }
        ]
      },
      "Skills": [
        {
          "Name": "sample string 1",
          "Abbreviation": "sample string 2",
          "Score": 3.1
        },
        {
          "Name": "sample string 1",
          "Abbreviation": "sample string 2",
          "Score": 3.1
        }
      ]
    }
  ]
}