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": "4fe13f7b-7b4c-49f6-bdb7-ca3dc9f1a791",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-02-19T10:31:24.1239125+00:00",
  "Registration": [
    {
      "Id": "f433a5ce-89da-4939-8f5a-9bc59378c296",
      "UserId": "bef6c30b-44d6-4c7d-8e95-127c1df88369",
      "IsCurrent": true,
      "CenterId": "cad14455-0b52-4cc5-95d6-3ee8b1c94a9b",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "e2b0ad98-df1f-4265-afe4-51c00a8b5cba",
      "EndDate": "2026-02-19T10:31:24.108287+00:00",
      "StartDate": "2026-02-19T10:31:24.108287+00:00",
      "SchedulePreferenceDate": "2026-02-19T10:31:24.108287+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": "f433a5ce-89da-4939-8f5a-9bc59378c296",
      "UserId": "bef6c30b-44d6-4c7d-8e95-127c1df88369",
      "IsCurrent": true,
      "CenterId": "cad14455-0b52-4cc5-95d6-3ee8b1c94a9b",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "e2b0ad98-df1f-4265-afe4-51c00a8b5cba",
      "EndDate": "2026-02-19T10:31:24.108287+00:00",
      "StartDate": "2026-02-19T10:31:24.108287+00:00",
      "SchedulePreferenceDate": "2026-02-19T10:31:24.108287+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-02-19T10:31:24.108287+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "db3962b4-97f1-4847-9f7a-5da55cb4e2bb",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "12dcdc68-be77-4bfd-ae82-1cb2db08ed10",
      "Sequence": 1,
      "AncestorCategoryId": "d56e658f-a26d-4291-b115-f00a4b41587d",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "08ae6169-fccf-4769-b4c0-c396548c8930",
          "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": "08ae6169-fccf-4769-b4c0-c396548c8930",
          "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": "db3962b4-97f1-4847-9f7a-5da55cb4e2bb",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "12dcdc68-be77-4bfd-ae82-1cb2db08ed10",
      "Sequence": 1,
      "AncestorCategoryId": "d56e658f-a26d-4291-b115-f00a4b41587d",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "08ae6169-fccf-4769-b4c0-c396548c8930",
          "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": "08ae6169-fccf-4769-b4c0-c396548c8930",
          "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": "c06dc4c6-1ccd-4d07-9a40-57c54907139b",
    "CategoryId": "3447c467-e2fd-4c19-ae64-0bb9fbe14f88",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "c3ff3bd7-4402-4390-a8f4-53ca2fe65f80",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "c3ff3bd7-4402-4390-a8f4-53ca2fe65f80",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "5d93b0f4-429a-4312-97f1-174f8b3ef3ce",
      "Questions": [
        {
          "Id": "dcd3d929-0c90-405a-8379-94e5fb0e7c54",
          "Answers": "sample string 2"
        },
        {
          "Id": "dcd3d929-0c90-405a-8379-94e5fb0e7c54",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "5d93b0f4-429a-4312-97f1-174f8b3ef3ce",
      "Questions": [
        {
          "Id": "dcd3d929-0c90-405a-8379-94e5fb0e7c54",
          "Answers": "sample string 2"
        },
        {
          "Id": "dcd3d929-0c90-405a-8379-94e5fb0e7c54",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "7e508921-a666-426f-81f7-ae07680d35b0",
      "ContentItemId": "62dc1331-980f-4e25-8685-6266e77204ed",
      "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-02-19T10:31:24.1239125+00:00",
      "RescheduleDate": "2026-02-19T10:31:24.1239125+00:00"
    },
    {
      "Id": "7e508921-a666-426f-81f7-ae07680d35b0",
      "ContentItemId": "62dc1331-980f-4e25-8685-6266e77204ed",
      "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-02-19T10:31:24.1239125+00:00",
      "RescheduleDate": "2026-02-19T10:31:24.1239125+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": "4fe13f7b-7b4c-49f6-bdb7-ca3dc9f1a791",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-02-19T10:31:24.670795+00:00",
  "Registration": [
    {
      "Id": "f433a5ce-89da-4939-8f5a-9bc59378c296",
      "UserId": "bef6c30b-44d6-4c7d-8e95-127c1df88369",
      "IsCurrent": true,
      "CenterId": "cad14455-0b52-4cc5-95d6-3ee8b1c94a9b",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "e2b0ad98-df1f-4265-afe4-51c00a8b5cba",
      "EndDate": "2026-02-19T10:31:24.108287+00:00",
      "StartDate": "2026-02-19T10:31:24.108287+00:00",
      "SchedulePreferenceDate": "2026-02-19T10:31:24.108287+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": "f433a5ce-89da-4939-8f5a-9bc59378c296",
      "UserId": "bef6c30b-44d6-4c7d-8e95-127c1df88369",
      "IsCurrent": true,
      "CenterId": "cad14455-0b52-4cc5-95d6-3ee8b1c94a9b",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "e2b0ad98-df1f-4265-afe4-51c00a8b5cba",
      "EndDate": "2026-02-19T10:31:24.108287+00:00",
      "StartDate": "2026-02-19T10:31:24.108287+00:00",
      "SchedulePreferenceDate": "2026-02-19T10:31:24.108287+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-02-19T10:31:24.108287+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "db3962b4-97f1-4847-9f7a-5da55cb4e2bb",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "12dcdc68-be77-4bfd-ae82-1cb2db08ed10",
      "Sequence": 1,
      "AncestorCategoryId": "d56e658f-a26d-4291-b115-f00a4b41587d",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "08ae6169-fccf-4769-b4c0-c396548c8930",
          "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": "08ae6169-fccf-4769-b4c0-c396548c8930",
          "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": "db3962b4-97f1-4847-9f7a-5da55cb4e2bb",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "12dcdc68-be77-4bfd-ae82-1cb2db08ed10",
      "Sequence": 1,
      "AncestorCategoryId": "d56e658f-a26d-4291-b115-f00a4b41587d",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "08ae6169-fccf-4769-b4c0-c396548c8930",
          "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": "08ae6169-fccf-4769-b4c0-c396548c8930",
          "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": "c06dc4c6-1ccd-4d07-9a40-57c54907139b",
    "CategoryId": "3447c467-e2fd-4c19-ae64-0bb9fbe14f88",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "c3ff3bd7-4402-4390-a8f4-53ca2fe65f80",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "c3ff3bd7-4402-4390-a8f4-53ca2fe65f80",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "5d93b0f4-429a-4312-97f1-174f8b3ef3ce",
      "Questions": [
        {
          "Id": "dcd3d929-0c90-405a-8379-94e5fb0e7c54",
          "Answers": "sample string 2"
        },
        {
          "Id": "dcd3d929-0c90-405a-8379-94e5fb0e7c54",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "5d93b0f4-429a-4312-97f1-174f8b3ef3ce",
      "Questions": [
        {
          "Id": "dcd3d929-0c90-405a-8379-94e5fb0e7c54",
          "Answers": "sample string 2"
        },
        {
          "Id": "dcd3d929-0c90-405a-8379-94e5fb0e7c54",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "7e508921-a666-426f-81f7-ae07680d35b0",
      "ContentItemId": "62dc1331-980f-4e25-8685-6266e77204ed",
      "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-02-19T10:31:24.1239125+00:00",
      "RescheduleDate": "2026-02-19T10:31:24.1239125+00:00"
    },
    {
      "Id": "7e508921-a666-426f-81f7-ae07680d35b0",
      "ContentItemId": "62dc1331-980f-4e25-8685-6266e77204ed",
      "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-02-19T10:31:24.1239125+00:00",
      "RescheduleDate": "2026-02-19T10:31:24.1239125+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}