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": "5d3fdd03-2166-4cb9-9e29-1f09ac8478a8",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-03-07T09:08:19.3132506+00:00",
  "Registration": [
    {
      "Id": "909da199-1088-4865-af26-b10f3dd212ef",
      "UserId": "b8c878c4-eda2-4e70-ade7-f494b83df6cf",
      "IsCurrent": true,
      "CenterId": "b30c7a90-aa01-4ea8-8f27-edf32ac931e5",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "5f659045-0e4f-49a1-9f9f-4b8e861a3541",
      "EndDate": "2026-03-07T09:08:19.3132506+00:00",
      "StartDate": "2026-03-07T09:08:19.3132506+00:00",
      "SchedulePreferenceDate": "2026-03-07T09:08:19.3132506+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": "909da199-1088-4865-af26-b10f3dd212ef",
      "UserId": "b8c878c4-eda2-4e70-ade7-f494b83df6cf",
      "IsCurrent": true,
      "CenterId": "b30c7a90-aa01-4ea8-8f27-edf32ac931e5",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "5f659045-0e4f-49a1-9f9f-4b8e861a3541",
      "EndDate": "2026-03-07T09:08:19.3132506+00:00",
      "StartDate": "2026-03-07T09:08:19.3132506+00:00",
      "SchedulePreferenceDate": "2026-03-07T09:08:19.3132506+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-03-07T09:08:19.3132506+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "d854e0eb-7634-4269-a18f-42ec1984cfaf",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "2e6fe562-3388-4702-9b18-8155a6bb3842",
      "Sequence": 1,
      "AncestorCategoryId": "e94b682c-3e75-40c5-876c-7116ed05d93e",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "d952ef0e-d252-4c69-8afa-630a0ef1bbcd",
          "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": "d952ef0e-d252-4c69-8afa-630a0ef1bbcd",
          "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": "d854e0eb-7634-4269-a18f-42ec1984cfaf",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "2e6fe562-3388-4702-9b18-8155a6bb3842",
      "Sequence": 1,
      "AncestorCategoryId": "e94b682c-3e75-40c5-876c-7116ed05d93e",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "d952ef0e-d252-4c69-8afa-630a0ef1bbcd",
          "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": "d952ef0e-d252-4c69-8afa-630a0ef1bbcd",
          "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": "6a0a92a6-4d99-41c6-b2d5-9caf0b5731a3",
    "CategoryId": "236bc3c1-b3f8-4c3d-b447-a86ab6d4e7eb",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "a6e4f0c2-30ad-43ee-a608-0eae8e7dffcf",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "a6e4f0c2-30ad-43ee-a608-0eae8e7dffcf",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "d6916db6-f69c-4006-8b4d-958bc107b8c6",
      "Questions": [
        {
          "Id": "b278694a-1d90-438f-b99a-9a961b0950bc",
          "Answers": "sample string 2"
        },
        {
          "Id": "b278694a-1d90-438f-b99a-9a961b0950bc",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "d6916db6-f69c-4006-8b4d-958bc107b8c6",
      "Questions": [
        {
          "Id": "b278694a-1d90-438f-b99a-9a961b0950bc",
          "Answers": "sample string 2"
        },
        {
          "Id": "b278694a-1d90-438f-b99a-9a961b0950bc",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "a10e2c1f-ea87-4d5c-a211-341e0d93823e",
      "ContentItemId": "9c6a1e36-fc8d-446a-b3bb-d6beea00aef9",
      "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-03-07T09:08:19.3132506+00:00",
      "RescheduleDate": "2026-03-07T09:08:19.3132506+00:00"
    },
    {
      "Id": "a10e2c1f-ea87-4d5c-a211-341e0d93823e",
      "ContentItemId": "9c6a1e36-fc8d-446a-b3bb-d6beea00aef9",
      "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-03-07T09:08:19.3132506+00:00",
      "RescheduleDate": "2026-03-07T09:08:19.3132506+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": "5d3fdd03-2166-4cb9-9e29-1f09ac8478a8",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-03-07T09:08:19.360069+00:00",
  "Registration": [
    {
      "Id": "909da199-1088-4865-af26-b10f3dd212ef",
      "UserId": "b8c878c4-eda2-4e70-ade7-f494b83df6cf",
      "IsCurrent": true,
      "CenterId": "b30c7a90-aa01-4ea8-8f27-edf32ac931e5",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "5f659045-0e4f-49a1-9f9f-4b8e861a3541",
      "EndDate": "2026-03-07T09:08:19.3132506+00:00",
      "StartDate": "2026-03-07T09:08:19.3132506+00:00",
      "SchedulePreferenceDate": "2026-03-07T09:08:19.3132506+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": "909da199-1088-4865-af26-b10f3dd212ef",
      "UserId": "b8c878c4-eda2-4e70-ade7-f494b83df6cf",
      "IsCurrent": true,
      "CenterId": "b30c7a90-aa01-4ea8-8f27-edf32ac931e5",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "5f659045-0e4f-49a1-9f9f-4b8e861a3541",
      "EndDate": "2026-03-07T09:08:19.3132506+00:00",
      "StartDate": "2026-03-07T09:08:19.3132506+00:00",
      "SchedulePreferenceDate": "2026-03-07T09:08:19.3132506+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-03-07T09:08:19.3132506+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "d854e0eb-7634-4269-a18f-42ec1984cfaf",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "2e6fe562-3388-4702-9b18-8155a6bb3842",
      "Sequence": 1,
      "AncestorCategoryId": "e94b682c-3e75-40c5-876c-7116ed05d93e",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "d952ef0e-d252-4c69-8afa-630a0ef1bbcd",
          "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": "d952ef0e-d252-4c69-8afa-630a0ef1bbcd",
          "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": "d854e0eb-7634-4269-a18f-42ec1984cfaf",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "2e6fe562-3388-4702-9b18-8155a6bb3842",
      "Sequence": 1,
      "AncestorCategoryId": "e94b682c-3e75-40c5-876c-7116ed05d93e",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "d952ef0e-d252-4c69-8afa-630a0ef1bbcd",
          "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": "d952ef0e-d252-4c69-8afa-630a0ef1bbcd",
          "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": "6a0a92a6-4d99-41c6-b2d5-9caf0b5731a3",
    "CategoryId": "236bc3c1-b3f8-4c3d-b447-a86ab6d4e7eb",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "a6e4f0c2-30ad-43ee-a608-0eae8e7dffcf",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "a6e4f0c2-30ad-43ee-a608-0eae8e7dffcf",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "d6916db6-f69c-4006-8b4d-958bc107b8c6",
      "Questions": [
        {
          "Id": "b278694a-1d90-438f-b99a-9a961b0950bc",
          "Answers": "sample string 2"
        },
        {
          "Id": "b278694a-1d90-438f-b99a-9a961b0950bc",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "d6916db6-f69c-4006-8b4d-958bc107b8c6",
      "Questions": [
        {
          "Id": "b278694a-1d90-438f-b99a-9a961b0950bc",
          "Answers": "sample string 2"
        },
        {
          "Id": "b278694a-1d90-438f-b99a-9a961b0950bc",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "a10e2c1f-ea87-4d5c-a211-341e0d93823e",
      "ContentItemId": "9c6a1e36-fc8d-446a-b3bb-d6beea00aef9",
      "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-03-07T09:08:19.3132506+00:00",
      "RescheduleDate": "2026-03-07T09:08:19.3132506+00:00"
    },
    {
      "Id": "a10e2c1f-ea87-4d5c-a211-341e0d93823e",
      "ContentItemId": "9c6a1e36-fc8d-446a-b3bb-d6beea00aef9",
      "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-03-07T09:08:19.3132506+00:00",
      "RescheduleDate": "2026-03-07T09:08:19.3132506+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}