GET openapi/students/{userIdentifier}/units/{unitId}/lessonssummaries

Authorization

Access to this endpoint is granted if all following conditions are true:

  • Authenticated territory has access to center which matches identifier given in "centerId" uri parameter.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userIdentifier

PearsonEnglish.LearningServices.Business.Helpers.UserIdentifier

Required

unitId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

PearsonEnglish.LearningServices.Wse.Models.Views.Gradebook.UnitDetailsSummaryViewModel
NameDescriptionTypeAdditional information
LessonsSummaries

Collection of PearsonEnglish.LearningServices.Wse.Models.Views.Gradebook.LessonSummaryViewModel

None.

EncountersSummaries

Collection of PearsonEnglish.LearningServices.Core.Models.Views.EncounterItemResultViewModel

None.

Response Formats

application/json, text/json

Sample:
{
  "LessonsSummaries": [
    {
      "LessonNumber": "sample string 1",
      "ActivitiesSummary": {
        "Overall": 1,
        "Progress": 1.1,
        "Duration": 2,
        "Skills": [
          {
            "Name": "sample string 1",
            "Abbreviation": "sample string 2",
            "Score": 3.1
          },
          {
            "Name": "sample string 1",
            "Abbreviation": "sample string 2",
            "Score": 3.1
          }
        ]
      },
      "WorkbooksSummary": {
        "Overall": 1,
        "Progress": 1.1,
        "Duration": 2,
        "Skills": [
          {
            "Name": "sample string 1",
            "Abbreviation": "sample string 2",
            "Score": 3.1
          },
          {
            "Name": "sample string 1",
            "Abbreviation": "sample string 2",
            "Score": 3.1
          }
        ]
      }
    },
    {
      "LessonNumber": "sample string 1",
      "ActivitiesSummary": {
        "Overall": 1,
        "Progress": 1.1,
        "Duration": 2,
        "Skills": [
          {
            "Name": "sample string 1",
            "Abbreviation": "sample string 2",
            "Score": 3.1
          },
          {
            "Name": "sample string 1",
            "Abbreviation": "sample string 2",
            "Score": 3.1
          }
        ]
      },
      "WorkbooksSummary": {
        "Overall": 1,
        "Progress": 1.1,
        "Duration": 2,
        "Skills": [
          {
            "Name": "sample string 1",
            "Abbreviation": "sample string 2",
            "Score": 3.1
          },
          {
            "Name": "sample string 1",
            "Abbreviation": "sample string 2",
            "Score": 3.1
          }
        ]
      }
    }
  ],
  "EncountersSummaries": [
    {
      "TeacherFullName": "sample string 1",
      "Result": "sample string 2",
      "Feedback": "sample string 3",
      "Score": 1.0,
      "DateCompletion": "2024-12-20T14:13:16.9198251+00:00",
      "EncounterPartialResults": [
        {
          "SkillName": "sample string 1",
          "Result": 2
        },
        {
          "SkillName": "sample string 1",
          "Result": 2
        }
      ]
    },
    {
      "TeacherFullName": "sample string 1",
      "Result": "sample string 2",
      "Feedback": "sample string 3",
      "Score": 1.0,
      "DateCompletion": "2024-12-20T14:13:16.9198251+00:00",
      "EncounterPartialResults": [
        {
          "SkillName": "sample string 1",
          "Result": 2
        },
        {
          "SkillName": "sample string 1",
          "Result": 2
        }
      ]
    }
  ]
}