GET v2/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.View.UserStateViewModel
NameDescriptionTypeAdditional information
UserId

globally unique identifier

None.

IsNewUser

boolean

None.

UserName

string

None.

PrivacyPolicyApprove

boolean

None.

ServerTime

date

None.

Registration

Collection of 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.

StudentSpeakPlusLevelInfo

string

None.

Response Formats

application/json

Sample:
{
  "UserId": "34064f39-6c2f-4cc4-86b3-49f3734e3da2",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-11-19T10:29:28.8158758+00:00",
  "Registration": [
    {
      "Id": "d158247c-f1cc-4f5e-9a0c-7b27eacb7453",
      "UserId": "7d404c18-2e4c-48aa-93f4-c1769d603107",
      "IsCurrent": true,
      "CenterId": "eccf9bbb-28aa-4adf-838f-17c7c94e2563",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "0b3d1041-edd5-436d-a51e-ae8b8b1763cb",
      "EndDate": "2026-11-19T10:29:28.8158758+00:00",
      "StartDate": "2026-11-19T10:29:28.8158758+00:00",
      "SchedulePreferenceDate": "2026-11-19T10:29:28.8158758+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"
    },
    {
      "Id": "d158247c-f1cc-4f5e-9a0c-7b27eacb7453",
      "UserId": "7d404c18-2e4c-48aa-93f4-c1769d603107",
      "IsCurrent": true,
      "CenterId": "eccf9bbb-28aa-4adf-838f-17c7c94e2563",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "0b3d1041-edd5-436d-a51e-ae8b8b1763cb",
      "EndDate": "2026-11-19T10:29:28.8158758+00:00",
      "StartDate": "2026-11-19T10:29:28.8158758+00:00",
      "SchedulePreferenceDate": "2026-11-19T10:29:28.8158758+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-11-19T10:29:28.8158758+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "6d18739d-3fd1-405d-a37c-e8465601f103",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "f0684a47-f3ef-4234-8abd-4236aefdc6a0",
      "Sequence": 1,
      "AncestorCategoryId": "d2252912-90e9-4218-9c23-035d81adb4a1",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "33de7ae4-f6e1-4d16-8f6c-4f4632a70636",
          "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": "33de7ae4-f6e1-4d16-8f6c-4f4632a70636",
          "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": "6d18739d-3fd1-405d-a37c-e8465601f103",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "f0684a47-f3ef-4234-8abd-4236aefdc6a0",
      "Sequence": 1,
      "AncestorCategoryId": "d2252912-90e9-4218-9c23-035d81adb4a1",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "33de7ae4-f6e1-4d16-8f6c-4f4632a70636",
          "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": "33de7ae4-f6e1-4d16-8f6c-4f4632a70636",
          "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": "167805ec-8f37-4e62-9f4a-9d0108f9853b",
    "CategoryId": "f2174cb2-e3ed-4b06-8ca3-b41ff36d97a0",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "799543d6-6cff-4507-8ca6-2f3db25e2a5f",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "799543d6-6cff-4507-8ca6-2f3db25e2a5f",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "4c41b2a7-5559-4afe-b5d6-c094727dc027",
      "Questions": [
        {
          "Id": "22b73206-3c30-4c7b-82c4-93964cac3aa0",
          "Answers": "sample string 2"
        },
        {
          "Id": "22b73206-3c30-4c7b-82c4-93964cac3aa0",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "4c41b2a7-5559-4afe-b5d6-c094727dc027",
      "Questions": [
        {
          "Id": "22b73206-3c30-4c7b-82c4-93964cac3aa0",
          "Answers": "sample string 2"
        },
        {
          "Id": "22b73206-3c30-4c7b-82c4-93964cac3aa0",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "0bc49999-b7ce-4dba-8351-c84a93a8e712",
      "ContentItemId": "fecd0ab1-fc1c-4952-ad68-49954028ed41",
      "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-11-19T10:29:28.8158758+00:00",
      "RescheduleDate": "2026-11-19T10:29:28.8158758+00:00"
    },
    {
      "Id": "0bc49999-b7ce-4dba-8351-c84a93a8e712",
      "ContentItemId": "fecd0ab1-fc1c-4952-ad68-49954028ed41",
      "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-11-19T10:29:28.8158758+00:00",
      "RescheduleDate": "2026-11-19T10:29:28.8158758+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}

text/json

Sample:
{
  "UserId": "34064f39-6c2f-4cc4-86b3-49f3734e3da2",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-11-19T10:29:28.8783746+00:00",
  "Registration": [
    {
      "Id": "d158247c-f1cc-4f5e-9a0c-7b27eacb7453",
      "UserId": "7d404c18-2e4c-48aa-93f4-c1769d603107",
      "IsCurrent": true,
      "CenterId": "eccf9bbb-28aa-4adf-838f-17c7c94e2563",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "0b3d1041-edd5-436d-a51e-ae8b8b1763cb",
      "EndDate": "2026-11-19T10:29:28.8158758+00:00",
      "StartDate": "2026-11-19T10:29:28.8158758+00:00",
      "SchedulePreferenceDate": "2026-11-19T10:29:28.8158758+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"
    },
    {
      "Id": "d158247c-f1cc-4f5e-9a0c-7b27eacb7453",
      "UserId": "7d404c18-2e4c-48aa-93f4-c1769d603107",
      "IsCurrent": true,
      "CenterId": "eccf9bbb-28aa-4adf-838f-17c7c94e2563",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "0b3d1041-edd5-436d-a51e-ae8b8b1763cb",
      "EndDate": "2026-11-19T10:29:28.8158758+00:00",
      "StartDate": "2026-11-19T10:29:28.8158758+00:00",
      "SchedulePreferenceDate": "2026-11-19T10:29:28.8158758+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-11-19T10:29:28.8158758+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "6d18739d-3fd1-405d-a37c-e8465601f103",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "f0684a47-f3ef-4234-8abd-4236aefdc6a0",
      "Sequence": 1,
      "AncestorCategoryId": "d2252912-90e9-4218-9c23-035d81adb4a1",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "33de7ae4-f6e1-4d16-8f6c-4f4632a70636",
          "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": "33de7ae4-f6e1-4d16-8f6c-4f4632a70636",
          "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": "6d18739d-3fd1-405d-a37c-e8465601f103",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "f0684a47-f3ef-4234-8abd-4236aefdc6a0",
      "Sequence": 1,
      "AncestorCategoryId": "d2252912-90e9-4218-9c23-035d81adb4a1",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "33de7ae4-f6e1-4d16-8f6c-4f4632a70636",
          "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": "33de7ae4-f6e1-4d16-8f6c-4f4632a70636",
          "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": "167805ec-8f37-4e62-9f4a-9d0108f9853b",
    "CategoryId": "f2174cb2-e3ed-4b06-8ca3-b41ff36d97a0",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "799543d6-6cff-4507-8ca6-2f3db25e2a5f",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "799543d6-6cff-4507-8ca6-2f3db25e2a5f",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "4c41b2a7-5559-4afe-b5d6-c094727dc027",
      "Questions": [
        {
          "Id": "22b73206-3c30-4c7b-82c4-93964cac3aa0",
          "Answers": "sample string 2"
        },
        {
          "Id": "22b73206-3c30-4c7b-82c4-93964cac3aa0",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "4c41b2a7-5559-4afe-b5d6-c094727dc027",
      "Questions": [
        {
          "Id": "22b73206-3c30-4c7b-82c4-93964cac3aa0",
          "Answers": "sample string 2"
        },
        {
          "Id": "22b73206-3c30-4c7b-82c4-93964cac3aa0",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "0bc49999-b7ce-4dba-8351-c84a93a8e712",
      "ContentItemId": "fecd0ab1-fc1c-4952-ad68-49954028ed41",
      "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-11-19T10:29:28.8158758+00:00",
      "RescheduleDate": "2026-11-19T10:29:28.8158758+00:00"
    },
    {
      "Id": "0bc49999-b7ce-4dba-8351-c84a93a8e712",
      "ContentItemId": "fecd0ab1-fc1c-4952-ad68-49954028ed41",
      "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-11-19T10:29:28.8158758+00:00",
      "RescheduleDate": "2026-11-19T10:29:28.8158758+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}