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": "02cca3f2-002e-446d-9406-61077abe64d2",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-09-04T22:54:44.6839168+00:00",
  "Registration": [
    {
      "Id": "b051c37d-fc26-4406-a1d3-81a1b8a174b5",
      "UserId": "44fd20b7-f036-4fa0-b4d8-706798adb845",
      "IsCurrent": true,
      "CenterId": "8040340f-30f4-4adb-8358-31c49a13172f",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "3b8d5fb5-295a-46d3-9819-a682348a562c",
      "EndDate": "2026-09-04T22:54:44.6839168+00:00",
      "StartDate": "2026-09-04T22:54:44.6839168+00:00",
      "SchedulePreferenceDate": "2026-09-04T22:54:44.6839168+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": "b051c37d-fc26-4406-a1d3-81a1b8a174b5",
      "UserId": "44fd20b7-f036-4fa0-b4d8-706798adb845",
      "IsCurrent": true,
      "CenterId": "8040340f-30f4-4adb-8358-31c49a13172f",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "3b8d5fb5-295a-46d3-9819-a682348a562c",
      "EndDate": "2026-09-04T22:54:44.6839168+00:00",
      "StartDate": "2026-09-04T22:54:44.6839168+00:00",
      "SchedulePreferenceDate": "2026-09-04T22:54:44.6839168+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-09-04T22:54:44.6839168+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "e16dc12e-c0d3-455b-93d0-c696f8e6aa18",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "ed3844aa-ccc5-4433-82e1-9061a38ac114",
      "Sequence": 1,
      "AncestorCategoryId": "d7b604c5-8ede-46b0-8c60-48e2d9a04331",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "4fbc98b9-3492-4e71-a1d8-72d99389c6ea",
          "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": "4fbc98b9-3492-4e71-a1d8-72d99389c6ea",
          "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": "e16dc12e-c0d3-455b-93d0-c696f8e6aa18",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "ed3844aa-ccc5-4433-82e1-9061a38ac114",
      "Sequence": 1,
      "AncestorCategoryId": "d7b604c5-8ede-46b0-8c60-48e2d9a04331",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "4fbc98b9-3492-4e71-a1d8-72d99389c6ea",
          "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": "4fbc98b9-3492-4e71-a1d8-72d99389c6ea",
          "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": "bb839d8b-176a-4bd0-99b5-1f3a4fe42d2b",
    "CategoryId": "593ad083-7273-4036-9f3c-0e70881d473b",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "2833543d-6466-41bd-84a7-c4b5a0ae9d86",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "2833543d-6466-41bd-84a7-c4b5a0ae9d86",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "d525acf6-af10-4573-84b8-3b0d2e280e56",
      "Questions": [
        {
          "Id": "dcdf2eb0-7578-4b9c-91b4-58af2f2ccf50",
          "Answers": "sample string 2"
        },
        {
          "Id": "dcdf2eb0-7578-4b9c-91b4-58af2f2ccf50",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "d525acf6-af10-4573-84b8-3b0d2e280e56",
      "Questions": [
        {
          "Id": "dcdf2eb0-7578-4b9c-91b4-58af2f2ccf50",
          "Answers": "sample string 2"
        },
        {
          "Id": "dcdf2eb0-7578-4b9c-91b4-58af2f2ccf50",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "8cc25435-7b88-483e-b2bc-66473ca0dcf4",
      "ContentItemId": "5a8d3a90-75b5-47c9-a410-fafe3fbad459",
      "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-09-04T22:54:44.6839168+00:00",
      "RescheduleDate": "2026-09-04T22:54:44.6839168+00:00"
    },
    {
      "Id": "8cc25435-7b88-483e-b2bc-66473ca0dcf4",
      "ContentItemId": "5a8d3a90-75b5-47c9-a410-fafe3fbad459",
      "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-09-04T22:54:44.6839168+00:00",
      "RescheduleDate": "2026-09-04T22:54:44.6839168+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": "02cca3f2-002e-446d-9406-61077abe64d2",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-09-04T22:54:44.7151154+00:00",
  "Registration": [
    {
      "Id": "b051c37d-fc26-4406-a1d3-81a1b8a174b5",
      "UserId": "44fd20b7-f036-4fa0-b4d8-706798adb845",
      "IsCurrent": true,
      "CenterId": "8040340f-30f4-4adb-8358-31c49a13172f",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "3b8d5fb5-295a-46d3-9819-a682348a562c",
      "EndDate": "2026-09-04T22:54:44.6839168+00:00",
      "StartDate": "2026-09-04T22:54:44.6839168+00:00",
      "SchedulePreferenceDate": "2026-09-04T22:54:44.6839168+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": "b051c37d-fc26-4406-a1d3-81a1b8a174b5",
      "UserId": "44fd20b7-f036-4fa0-b4d8-706798adb845",
      "IsCurrent": true,
      "CenterId": "8040340f-30f4-4adb-8358-31c49a13172f",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "3b8d5fb5-295a-46d3-9819-a682348a562c",
      "EndDate": "2026-09-04T22:54:44.6839168+00:00",
      "StartDate": "2026-09-04T22:54:44.6839168+00:00",
      "SchedulePreferenceDate": "2026-09-04T22:54:44.6839168+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-09-04T22:54:44.6839168+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "e16dc12e-c0d3-455b-93d0-c696f8e6aa18",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "ed3844aa-ccc5-4433-82e1-9061a38ac114",
      "Sequence": 1,
      "AncestorCategoryId": "d7b604c5-8ede-46b0-8c60-48e2d9a04331",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "4fbc98b9-3492-4e71-a1d8-72d99389c6ea",
          "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": "4fbc98b9-3492-4e71-a1d8-72d99389c6ea",
          "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": "e16dc12e-c0d3-455b-93d0-c696f8e6aa18",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "ed3844aa-ccc5-4433-82e1-9061a38ac114",
      "Sequence": 1,
      "AncestorCategoryId": "d7b604c5-8ede-46b0-8c60-48e2d9a04331",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "4fbc98b9-3492-4e71-a1d8-72d99389c6ea",
          "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": "4fbc98b9-3492-4e71-a1d8-72d99389c6ea",
          "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": "bb839d8b-176a-4bd0-99b5-1f3a4fe42d2b",
    "CategoryId": "593ad083-7273-4036-9f3c-0e70881d473b",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "2833543d-6466-41bd-84a7-c4b5a0ae9d86",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "2833543d-6466-41bd-84a7-c4b5a0ae9d86",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "d525acf6-af10-4573-84b8-3b0d2e280e56",
      "Questions": [
        {
          "Id": "dcdf2eb0-7578-4b9c-91b4-58af2f2ccf50",
          "Answers": "sample string 2"
        },
        {
          "Id": "dcdf2eb0-7578-4b9c-91b4-58af2f2ccf50",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "d525acf6-af10-4573-84b8-3b0d2e280e56",
      "Questions": [
        {
          "Id": "dcdf2eb0-7578-4b9c-91b4-58af2f2ccf50",
          "Answers": "sample string 2"
        },
        {
          "Id": "dcdf2eb0-7578-4b9c-91b4-58af2f2ccf50",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "8cc25435-7b88-483e-b2bc-66473ca0dcf4",
      "ContentItemId": "5a8d3a90-75b5-47c9-a410-fafe3fbad459",
      "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-09-04T22:54:44.6839168+00:00",
      "RescheduleDate": "2026-09-04T22:54:44.6839168+00:00"
    },
    {
      "Id": "8cc25435-7b88-483e-b2bc-66473ca0dcf4",
      "ContentItemId": "5a8d3a90-75b5-47c9-a410-fafe3fbad459",
      "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-09-04T22:54:44.6839168+00:00",
      "RescheduleDate": "2026-09-04T22:54:44.6839168+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}