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": "0e59e79a-f231-415d-a234-e2eb4702d0d8",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-10-22T04:36:38.1948657+00:00",
  "Registration": [
    {
      "Id": "2afc8e9a-793d-4269-818c-ec3035c0c857",
      "UserId": "12f2df2d-166f-4677-a111-3d1164e146df",
      "IsCurrent": true,
      "CenterId": "e78b27e0-87ab-43ab-82d6-1c478e847edc",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "5c19fe2d-f886-4efb-917d-0a1444508178",
      "EndDate": "2026-10-22T04:36:38.1948657+00:00",
      "StartDate": "2026-10-22T04:36:38.1948657+00:00",
      "SchedulePreferenceDate": "2026-10-22T04:36:38.1948657+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": "2afc8e9a-793d-4269-818c-ec3035c0c857",
      "UserId": "12f2df2d-166f-4677-a111-3d1164e146df",
      "IsCurrent": true,
      "CenterId": "e78b27e0-87ab-43ab-82d6-1c478e847edc",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "5c19fe2d-f886-4efb-917d-0a1444508178",
      "EndDate": "2026-10-22T04:36:38.1948657+00:00",
      "StartDate": "2026-10-22T04:36:38.1948657+00:00",
      "SchedulePreferenceDate": "2026-10-22T04:36:38.1948657+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-10-22T04:36:38.1948657+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "f750b440-1ca6-433d-9e87-60072b847ad9",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "207d26e1-5ad3-49c7-bd71-4259ff85f590",
      "Sequence": 1,
      "AncestorCategoryId": "a696f186-1d78-45a6-8722-7d3ecaa8d2dd",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "f32c9644-8373-42a5-92ae-919969fa7a5b",
          "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": "f32c9644-8373-42a5-92ae-919969fa7a5b",
          "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": "f750b440-1ca6-433d-9e87-60072b847ad9",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "207d26e1-5ad3-49c7-bd71-4259ff85f590",
      "Sequence": 1,
      "AncestorCategoryId": "a696f186-1d78-45a6-8722-7d3ecaa8d2dd",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "f32c9644-8373-42a5-92ae-919969fa7a5b",
          "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": "f32c9644-8373-42a5-92ae-919969fa7a5b",
          "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": "0499c8af-9305-4db1-a7f2-026e7555ffa6",
    "CategoryId": "24298f85-087f-44bd-aee6-cf7e093e3a1c",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "a15df8c0-37e2-48ea-8ee7-7caa06af1784",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "a15df8c0-37e2-48ea-8ee7-7caa06af1784",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "7d6dc803-35fd-4f61-b926-259c50a3353c",
      "Questions": [
        {
          "Id": "9fff4072-c9e5-4510-b773-e5e5c2d7bc75",
          "Answers": "sample string 2"
        },
        {
          "Id": "9fff4072-c9e5-4510-b773-e5e5c2d7bc75",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "7d6dc803-35fd-4f61-b926-259c50a3353c",
      "Questions": [
        {
          "Id": "9fff4072-c9e5-4510-b773-e5e5c2d7bc75",
          "Answers": "sample string 2"
        },
        {
          "Id": "9fff4072-c9e5-4510-b773-e5e5c2d7bc75",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "e8dc260b-a517-4f2c-9401-8c35e5e9192e",
      "ContentItemId": "6ed0dab3-e4fe-4154-9df6-f3257d0b5787",
      "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-10-22T04:36:38.1948657+00:00",
      "RescheduleDate": "2026-10-22T04:36:38.1948657+00:00"
    },
    {
      "Id": "e8dc260b-a517-4f2c-9401-8c35e5e9192e",
      "ContentItemId": "6ed0dab3-e4fe-4154-9df6-f3257d0b5787",
      "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-10-22T04:36:38.1948657+00:00",
      "RescheduleDate": "2026-10-22T04:36:38.1948657+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": "0e59e79a-f231-415d-a234-e2eb4702d0d8",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-10-22T04:36:38.2261166+00:00",
  "Registration": [
    {
      "Id": "2afc8e9a-793d-4269-818c-ec3035c0c857",
      "UserId": "12f2df2d-166f-4677-a111-3d1164e146df",
      "IsCurrent": true,
      "CenterId": "e78b27e0-87ab-43ab-82d6-1c478e847edc",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "5c19fe2d-f886-4efb-917d-0a1444508178",
      "EndDate": "2026-10-22T04:36:38.1948657+00:00",
      "StartDate": "2026-10-22T04:36:38.1948657+00:00",
      "SchedulePreferenceDate": "2026-10-22T04:36:38.1948657+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": "2afc8e9a-793d-4269-818c-ec3035c0c857",
      "UserId": "12f2df2d-166f-4677-a111-3d1164e146df",
      "IsCurrent": true,
      "CenterId": "e78b27e0-87ab-43ab-82d6-1c478e847edc",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "5c19fe2d-f886-4efb-917d-0a1444508178",
      "EndDate": "2026-10-22T04:36:38.1948657+00:00",
      "StartDate": "2026-10-22T04:36:38.1948657+00:00",
      "SchedulePreferenceDate": "2026-10-22T04:36:38.1948657+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-10-22T04:36:38.1948657+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "f750b440-1ca6-433d-9e87-60072b847ad9",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "207d26e1-5ad3-49c7-bd71-4259ff85f590",
      "Sequence": 1,
      "AncestorCategoryId": "a696f186-1d78-45a6-8722-7d3ecaa8d2dd",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "f32c9644-8373-42a5-92ae-919969fa7a5b",
          "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": "f32c9644-8373-42a5-92ae-919969fa7a5b",
          "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": "f750b440-1ca6-433d-9e87-60072b847ad9",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "207d26e1-5ad3-49c7-bd71-4259ff85f590",
      "Sequence": 1,
      "AncestorCategoryId": "a696f186-1d78-45a6-8722-7d3ecaa8d2dd",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "f32c9644-8373-42a5-92ae-919969fa7a5b",
          "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": "f32c9644-8373-42a5-92ae-919969fa7a5b",
          "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": "0499c8af-9305-4db1-a7f2-026e7555ffa6",
    "CategoryId": "24298f85-087f-44bd-aee6-cf7e093e3a1c",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "a15df8c0-37e2-48ea-8ee7-7caa06af1784",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "a15df8c0-37e2-48ea-8ee7-7caa06af1784",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "7d6dc803-35fd-4f61-b926-259c50a3353c",
      "Questions": [
        {
          "Id": "9fff4072-c9e5-4510-b773-e5e5c2d7bc75",
          "Answers": "sample string 2"
        },
        {
          "Id": "9fff4072-c9e5-4510-b773-e5e5c2d7bc75",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "7d6dc803-35fd-4f61-b926-259c50a3353c",
      "Questions": [
        {
          "Id": "9fff4072-c9e5-4510-b773-e5e5c2d7bc75",
          "Answers": "sample string 2"
        },
        {
          "Id": "9fff4072-c9e5-4510-b773-e5e5c2d7bc75",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "e8dc260b-a517-4f2c-9401-8c35e5e9192e",
      "ContentItemId": "6ed0dab3-e4fe-4154-9df6-f3257d0b5787",
      "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-10-22T04:36:38.1948657+00:00",
      "RescheduleDate": "2026-10-22T04:36:38.1948657+00:00"
    },
    {
      "Id": "e8dc260b-a517-4f2c-9401-8c35e5e9192e",
      "ContentItemId": "6ed0dab3-e4fe-4154-9df6-f3257d0b5787",
      "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-10-22T04:36:38.1948657+00:00",
      "RescheduleDate": "2026-10-22T04:36:38.1948657+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}