GET users/{userIdentifier}/state

Gets the User's state information.

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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userIdentifier

user's identifier

PearsonEnglish.LearningServices.Business.Helpers.UserIdentifier

Required

Body Parameters

None.

Response Information

Resource Description

PearsonEnglish.LearningServices.Core.Models.Views.UserStateBackwardCompatibleViewModel
NameDescriptionTypeAdditional information
UserId

globally unique identifier

None.

IsNewUser

boolean

None.

UserName

string

None.

PrivacyPolicyApprove

boolean

None.

ServerTime

date

None.

Registration

PearsonEnglish.LearningServices.Core.Models.Views.RegistrationViewModel

None.

TimeZone

PearsonEnglish.LearningServices.Core.Models.Views.TimeZoneViewModel

None.

Bookmarks

Dictionary of string [key] and PearsonEnglish.LearningServices.Core.Models.Views.ContentItemViewModel [value]

None.

CurrentCourse

PearsonEnglish.LearningServices.Core.Models.CurrentCourse

None.

Lessons

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

None.

Surveys

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

None.

Sessions

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

None.

TotalRescheduleCount

integer

None.

StudentLevelInfo

PearsonEnglish.LearningServices.Core.Models.StudentLevelInfo

None.

Response Formats

application/json

Sample:
{
  "UserId": "66264ac0-0b34-4cf8-8b9e-7d77d4b2618b",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-08-28T15:44:11.0911813+00:00",
  "Registration": {
    "Id": "b74422ee-70c6-4ea6-abaf-68ac4153e277",
    "UserId": "78c86192-9178-4781-8662-759b467b921f",
    "IsCurrent": true,
    "CenterId": "a799ba26-d812-4928-bad9-d4f52c9ed1e7",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "bafcfe3f-0347-4800-9583-33bb285f7472",
    "EndDate": "2026-08-28T15:44:11.0755566+00:00",
    "StartDate": "2026-08-28T15:44:11.0755566+00:00",
    "SchedulePreferenceDate": "2026-08-28T15:44:11.0755566+00:00",
    "TypeName": "sample string 10",
    "WorkbookType": 0,
    "EnglishAnytime": true,
    "AllowSelfBooking": true,
    "RegistrationStatus": "sample string 12",
    "CourseStatus": "sample string 13",
    "StudentCurrentContractStatus": "sample string 14",
    "OnlineClassAccess": true,
    "InCenterClassAccess": true,
    "IsMembership": true,
    "IsPromo": true,
    "OnboardingAccess": true,
    "IsCrossCenterBooking": true,
    "IsTeen": true,
    "IsGroupContract": true,
    "IsB2B": true,
    "ServiceType": 1,
    "LabTeacherReferenceId": "sample string 24",
    "ConsultantReferenceId": "sample string 25"
  },
  "TimeZone": {
    "Name": "sample string 1",
    "IanaName": "sample string 2",
    "LocalUtcOffset": "00:00:00.1234567",
    "LocalDateTime": "2026-08-28T15:44:11.0755566+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "6026b43e-24dc-4416-ad33-6db495f106c4",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "5baed9d8-8368-4a56-afdb-13546b394210",
      "Sequence": 1,
      "AncestorCategoryId": "1764de7f-893e-463b-90c4-9c90020c5630",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "051d7ca8-826d-4406-9868-0a4b275dfdc1",
          "Type": "sample string 2",
          "Sequence": 1,
          "Path": "sample string 3",
          "Attributes": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "ChildCategories": []
        },
        {
          "Id": "051d7ca8-826d-4406-9868-0a4b275dfdc1",
          "Type": "sample string 2",
          "Sequence": 1,
          "Path": "sample string 3",
          "Attributes": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "ChildCategories": []
        }
      ],
      "ContentOptimizationLevelId": 7,
      "ContentOptimizationLevelName": "sample string 8"
    },
    "sample string 2": {
      "Id": "6026b43e-24dc-4416-ad33-6db495f106c4",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "5baed9d8-8368-4a56-afdb-13546b394210",
      "Sequence": 1,
      "AncestorCategoryId": "1764de7f-893e-463b-90c4-9c90020c5630",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "051d7ca8-826d-4406-9868-0a4b275dfdc1",
          "Type": "sample string 2",
          "Sequence": 1,
          "Path": "sample string 3",
          "Attributes": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "ChildCategories": []
        },
        {
          "Id": "051d7ca8-826d-4406-9868-0a4b275dfdc1",
          "Type": "sample string 2",
          "Sequence": 1,
          "Path": "sample string 3",
          "Attributes": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "ChildCategories": []
        }
      ],
      "ContentOptimizationLevelId": 7,
      "ContentOptimizationLevelName": "sample string 8"
    }
  },
  "CurrentCourse": {
    "Id": "b820470d-2c09-4efb-ba0b-3175aaf3b4aa",
    "CategoryId": "fb3cdbff-fc0f-42d4-af27-100079c45ea1",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "1d511b49-0b7a-41a4-ba1d-f4f2e870b5ff",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "1d511b49-0b7a-41a4-ba1d-f4f2e870b5ff",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "dcffc844-dd44-4586-8225-fd22441b7663",
      "Questions": [
        {
          "Id": "9da10ef1-f096-4df5-ac96-1d95087b34f0",
          "Answers": "sample string 2"
        },
        {
          "Id": "9da10ef1-f096-4df5-ac96-1d95087b34f0",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "dcffc844-dd44-4586-8225-fd22441b7663",
      "Questions": [
        {
          "Id": "9da10ef1-f096-4df5-ac96-1d95087b34f0",
          "Answers": "sample string 2"
        },
        {
          "Id": "9da10ef1-f096-4df5-ac96-1d95087b34f0",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "c0a92326-3933-44de-8a09-2ea16914771f",
      "ContentItemId": "3f103b67-21fa-482e-866f-461bc8112988",
      "Status": "sample string 3",
      "TeacherFeedbacks": [
        {
          "Type": "sample string 1",
          "Value1": "sample string 2",
          "Value2": "sample string 3"
        },
        {
          "Type": "sample string 1",
          "Value1": "sample string 2",
          "Value2": "sample string 3"
        }
      ],
      "RatingDate": "2026-08-28T15:44:11.0755566+00:00",
      "RescheduleDate": "2026-08-28T15:44:11.0755566+00:00"
    },
    {
      "Id": "c0a92326-3933-44de-8a09-2ea16914771f",
      "ContentItemId": "3f103b67-21fa-482e-866f-461bc8112988",
      "Status": "sample string 3",
      "TeacherFeedbacks": [
        {
          "Type": "sample string 1",
          "Value1": "sample string 2",
          "Value2": "sample string 3"
        },
        {
          "Type": "sample string 1",
          "Value1": "sample string 2",
          "Value2": "sample string 3"
        }
      ],
      "RatingDate": "2026-08-28T15:44:11.0755566+00:00",
      "RescheduleDate": "2026-08-28T15:44:11.0755566+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}

text/json

Sample:
{
  "UserId": "66264ac0-0b34-4cf8-8b9e-7d77d4b2618b",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-08-28T15:44:11.1224301+00:00",
  "Registration": {
    "Id": "b74422ee-70c6-4ea6-abaf-68ac4153e277",
    "UserId": "78c86192-9178-4781-8662-759b467b921f",
    "IsCurrent": true,
    "CenterId": "a799ba26-d812-4928-bad9-d4f52c9ed1e7",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "bafcfe3f-0347-4800-9583-33bb285f7472",
    "EndDate": "2026-08-28T15:44:11.0755566+00:00",
    "StartDate": "2026-08-28T15:44:11.0755566+00:00",
    "SchedulePreferenceDate": "2026-08-28T15:44:11.0755566+00:00",
    "TypeName": "sample string 10",
    "WorkbookType": 0,
    "EnglishAnytime": true,
    "AllowSelfBooking": true,
    "RegistrationStatus": "sample string 12",
    "CourseStatus": "sample string 13",
    "StudentCurrentContractStatus": "sample string 14",
    "OnlineClassAccess": true,
    "InCenterClassAccess": true,
    "IsMembership": true,
    "IsPromo": true,
    "OnboardingAccess": true,
    "IsCrossCenterBooking": true,
    "IsTeen": true,
    "IsGroupContract": true,
    "IsB2B": true,
    "ServiceType": 1,
    "LabTeacherReferenceId": "sample string 24",
    "ConsultantReferenceId": "sample string 25"
  },
  "TimeZone": {
    "Name": "sample string 1",
    "IanaName": "sample string 2",
    "LocalUtcOffset": "00:00:00.1234567",
    "LocalDateTime": "2026-08-28T15:44:11.0755566+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "6026b43e-24dc-4416-ad33-6db495f106c4",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "5baed9d8-8368-4a56-afdb-13546b394210",
      "Sequence": 1,
      "AncestorCategoryId": "1764de7f-893e-463b-90c4-9c90020c5630",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "051d7ca8-826d-4406-9868-0a4b275dfdc1",
          "Type": "sample string 2",
          "Sequence": 1,
          "Path": "sample string 3",
          "Attributes": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "ChildCategories": []
        },
        {
          "Id": "051d7ca8-826d-4406-9868-0a4b275dfdc1",
          "Type": "sample string 2",
          "Sequence": 1,
          "Path": "sample string 3",
          "Attributes": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "ChildCategories": []
        }
      ],
      "ContentOptimizationLevelId": 7,
      "ContentOptimizationLevelName": "sample string 8"
    },
    "sample string 2": {
      "Id": "6026b43e-24dc-4416-ad33-6db495f106c4",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "5baed9d8-8368-4a56-afdb-13546b394210",
      "Sequence": 1,
      "AncestorCategoryId": "1764de7f-893e-463b-90c4-9c90020c5630",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "051d7ca8-826d-4406-9868-0a4b275dfdc1",
          "Type": "sample string 2",
          "Sequence": 1,
          "Path": "sample string 3",
          "Attributes": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "ChildCategories": []
        },
        {
          "Id": "051d7ca8-826d-4406-9868-0a4b275dfdc1",
          "Type": "sample string 2",
          "Sequence": 1,
          "Path": "sample string 3",
          "Attributes": {
            "sample string 1": "sample string 2",
            "sample string 3": "sample string 4"
          },
          "ChildCategories": []
        }
      ],
      "ContentOptimizationLevelId": 7,
      "ContentOptimizationLevelName": "sample string 8"
    }
  },
  "CurrentCourse": {
    "Id": "b820470d-2c09-4efb-ba0b-3175aaf3b4aa",
    "CategoryId": "fb3cdbff-fc0f-42d4-af27-100079c45ea1",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "1d511b49-0b7a-41a4-ba1d-f4f2e870b5ff",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "1d511b49-0b7a-41a4-ba1d-f4f2e870b5ff",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "dcffc844-dd44-4586-8225-fd22441b7663",
      "Questions": [
        {
          "Id": "9da10ef1-f096-4df5-ac96-1d95087b34f0",
          "Answers": "sample string 2"
        },
        {
          "Id": "9da10ef1-f096-4df5-ac96-1d95087b34f0",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "dcffc844-dd44-4586-8225-fd22441b7663",
      "Questions": [
        {
          "Id": "9da10ef1-f096-4df5-ac96-1d95087b34f0",
          "Answers": "sample string 2"
        },
        {
          "Id": "9da10ef1-f096-4df5-ac96-1d95087b34f0",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "c0a92326-3933-44de-8a09-2ea16914771f",
      "ContentItemId": "3f103b67-21fa-482e-866f-461bc8112988",
      "Status": "sample string 3",
      "TeacherFeedbacks": [
        {
          "Type": "sample string 1",
          "Value1": "sample string 2",
          "Value2": "sample string 3"
        },
        {
          "Type": "sample string 1",
          "Value1": "sample string 2",
          "Value2": "sample string 3"
        }
      ],
      "RatingDate": "2026-08-28T15:44:11.0755566+00:00",
      "RescheduleDate": "2026-08-28T15:44:11.0755566+00:00"
    },
    {
      "Id": "c0a92326-3933-44de-8a09-2ea16914771f",
      "ContentItemId": "3f103b67-21fa-482e-866f-461bc8112988",
      "Status": "sample string 3",
      "TeacherFeedbacks": [
        {
          "Type": "sample string 1",
          "Value1": "sample string 2",
          "Value2": "sample string 3"
        },
        {
          "Type": "sample string 1",
          "Value1": "sample string 2",
          "Value2": "sample string 3"
        }
      ],
      "RatingDate": "2026-08-28T15:44:11.0755566+00:00",
      "RescheduleDate": "2026-08-28T15:44:11.0755566+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}