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": "a306e895-4998-4d4e-bbdc-e27d5f2e2a3f",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-04-23T08:53:54.7363412+00:00",
  "Registration": [
    {
      "Id": "baeea5ad-a9d5-4ea0-89cf-514b802a67e0",
      "UserId": "62c86fbf-8d8e-4a78-8b02-a677daa24382",
      "IsCurrent": true,
      "CenterId": "adc17406-4756-445d-80ab-480b113f413b",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "764614d6-3282-476c-bf75-e84326cee65a",
      "EndDate": "2026-04-23T08:53:54.7363412+00:00",
      "StartDate": "2026-04-23T08:53:54.7363412+00:00",
      "SchedulePreferenceDate": "2026-04-23T08:53:54.7363412+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": "baeea5ad-a9d5-4ea0-89cf-514b802a67e0",
      "UserId": "62c86fbf-8d8e-4a78-8b02-a677daa24382",
      "IsCurrent": true,
      "CenterId": "adc17406-4756-445d-80ab-480b113f413b",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "764614d6-3282-476c-bf75-e84326cee65a",
      "EndDate": "2026-04-23T08:53:54.7363412+00:00",
      "StartDate": "2026-04-23T08:53:54.7363412+00:00",
      "SchedulePreferenceDate": "2026-04-23T08:53:54.7363412+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-04-23T08:53:54.7363412+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "2b5d9153-bb96-4a8d-99e4-65aa38188554",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "a17ec8e3-6f60-4275-9913-ebb26847d7b2",
      "Sequence": 1,
      "AncestorCategoryId": "c32e1315-d934-456f-98a6-d4a13ed432fc",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "bbf41f96-4cd6-4499-bf9c-f85803a90454",
          "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": "bbf41f96-4cd6-4499-bf9c-f85803a90454",
          "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": "2b5d9153-bb96-4a8d-99e4-65aa38188554",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "a17ec8e3-6f60-4275-9913-ebb26847d7b2",
      "Sequence": 1,
      "AncestorCategoryId": "c32e1315-d934-456f-98a6-d4a13ed432fc",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "bbf41f96-4cd6-4499-bf9c-f85803a90454",
          "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": "bbf41f96-4cd6-4499-bf9c-f85803a90454",
          "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": "317e7c2b-56ec-4852-b87c-dfcaed7a5958",
    "CategoryId": "5e796d0b-9778-4e76-bf94-7f514996b75a",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "42e07cbd-f7c5-47b4-b4e0-01c832c9ec7c",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "42e07cbd-f7c5-47b4-b4e0-01c832c9ec7c",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "cdcd0179-227a-4cc1-be78-f896c23fa18b",
      "Questions": [
        {
          "Id": "4eba3ea4-7c01-4b5e-80a7-3528bea91997",
          "Answers": "sample string 2"
        },
        {
          "Id": "4eba3ea4-7c01-4b5e-80a7-3528bea91997",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "cdcd0179-227a-4cc1-be78-f896c23fa18b",
      "Questions": [
        {
          "Id": "4eba3ea4-7c01-4b5e-80a7-3528bea91997",
          "Answers": "sample string 2"
        },
        {
          "Id": "4eba3ea4-7c01-4b5e-80a7-3528bea91997",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "241c3bc0-a6b3-41b0-ba09-108a32cc90dd",
      "ContentItemId": "84ed811c-7dad-41fc-af37-8a65aaebaeb0",
      "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-04-23T08:53:54.7363412+00:00",
      "RescheduleDate": "2026-04-23T08:53:54.7363412+00:00"
    },
    {
      "Id": "241c3bc0-a6b3-41b0-ba09-108a32cc90dd",
      "ContentItemId": "84ed811c-7dad-41fc-af37-8a65aaebaeb0",
      "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-04-23T08:53:54.7363412+00:00",
      "RescheduleDate": "2026-04-23T08:53:54.7363412+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": "a306e895-4998-4d4e-bbdc-e27d5f2e2a3f",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-04-23T08:53:54.7675998+00:00",
  "Registration": [
    {
      "Id": "baeea5ad-a9d5-4ea0-89cf-514b802a67e0",
      "UserId": "62c86fbf-8d8e-4a78-8b02-a677daa24382",
      "IsCurrent": true,
      "CenterId": "adc17406-4756-445d-80ab-480b113f413b",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "764614d6-3282-476c-bf75-e84326cee65a",
      "EndDate": "2026-04-23T08:53:54.7363412+00:00",
      "StartDate": "2026-04-23T08:53:54.7363412+00:00",
      "SchedulePreferenceDate": "2026-04-23T08:53:54.7363412+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": "baeea5ad-a9d5-4ea0-89cf-514b802a67e0",
      "UserId": "62c86fbf-8d8e-4a78-8b02-a677daa24382",
      "IsCurrent": true,
      "CenterId": "adc17406-4756-445d-80ab-480b113f413b",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "764614d6-3282-476c-bf75-e84326cee65a",
      "EndDate": "2026-04-23T08:53:54.7363412+00:00",
      "StartDate": "2026-04-23T08:53:54.7363412+00:00",
      "SchedulePreferenceDate": "2026-04-23T08:53:54.7363412+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-04-23T08:53:54.7363412+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "2b5d9153-bb96-4a8d-99e4-65aa38188554",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "a17ec8e3-6f60-4275-9913-ebb26847d7b2",
      "Sequence": 1,
      "AncestorCategoryId": "c32e1315-d934-456f-98a6-d4a13ed432fc",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "bbf41f96-4cd6-4499-bf9c-f85803a90454",
          "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": "bbf41f96-4cd6-4499-bf9c-f85803a90454",
          "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": "2b5d9153-bb96-4a8d-99e4-65aa38188554",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "a17ec8e3-6f60-4275-9913-ebb26847d7b2",
      "Sequence": 1,
      "AncestorCategoryId": "c32e1315-d934-456f-98a6-d4a13ed432fc",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "bbf41f96-4cd6-4499-bf9c-f85803a90454",
          "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": "bbf41f96-4cd6-4499-bf9c-f85803a90454",
          "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": "317e7c2b-56ec-4852-b87c-dfcaed7a5958",
    "CategoryId": "5e796d0b-9778-4e76-bf94-7f514996b75a",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "42e07cbd-f7c5-47b4-b4e0-01c832c9ec7c",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "42e07cbd-f7c5-47b4-b4e0-01c832c9ec7c",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "cdcd0179-227a-4cc1-be78-f896c23fa18b",
      "Questions": [
        {
          "Id": "4eba3ea4-7c01-4b5e-80a7-3528bea91997",
          "Answers": "sample string 2"
        },
        {
          "Id": "4eba3ea4-7c01-4b5e-80a7-3528bea91997",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "cdcd0179-227a-4cc1-be78-f896c23fa18b",
      "Questions": [
        {
          "Id": "4eba3ea4-7c01-4b5e-80a7-3528bea91997",
          "Answers": "sample string 2"
        },
        {
          "Id": "4eba3ea4-7c01-4b5e-80a7-3528bea91997",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "241c3bc0-a6b3-41b0-ba09-108a32cc90dd",
      "ContentItemId": "84ed811c-7dad-41fc-af37-8a65aaebaeb0",
      "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-04-23T08:53:54.7363412+00:00",
      "RescheduleDate": "2026-04-23T08:53:54.7363412+00:00"
    },
    {
      "Id": "241c3bc0-a6b3-41b0-ba09-108a32cc90dd",
      "ContentItemId": "84ed811c-7dad-41fc-af37-8a65aaebaeb0",
      "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-04-23T08:53:54.7363412+00:00",
      "RescheduleDate": "2026-04-23T08:53:54.7363412+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}