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
| Name | Description | Type | Additional information |
|---|---|---|---|
| userIdentifier |
user's identifier |
PearsonEnglish.LearningServices.Business.Helpers.UserIdentifier |
Required |
Body Parameters
None.
Response Information
Resource Description
PearsonEnglish.LearningServices.Core.Models.View.UserStateViewModelResponse Formats
application/json
Sample:
{
"UserId": "73bc637f-eb52-4711-9730-b51b31a4b7b6",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-01-13T03:22:34.034132+00:00",
"Registration": [
{
"Id": "2b566d88-7f80-4d67-a3d5-b0518ce5b84d",
"UserId": "b36f6119-4f54-44f5-934e-7db30048b164",
"IsCurrent": true,
"CenterId": "d6dfad04-101c-4178-9b53-8d8c1190b96d",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "946f42ca-7999-41ab-9237-c3a69eb521cc",
"EndDate": "2026-01-13T03:22:34.0185039+00:00",
"StartDate": "2026-01-13T03:22:34.0185039+00:00",
"SchedulePreferenceDate": "2026-01-13T03:22:34.0185039+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": "2b566d88-7f80-4d67-a3d5-b0518ce5b84d",
"UserId": "b36f6119-4f54-44f5-934e-7db30048b164",
"IsCurrent": true,
"CenterId": "d6dfad04-101c-4178-9b53-8d8c1190b96d",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "946f42ca-7999-41ab-9237-c3a69eb521cc",
"EndDate": "2026-01-13T03:22:34.0185039+00:00",
"StartDate": "2026-01-13T03:22:34.0185039+00:00",
"SchedulePreferenceDate": "2026-01-13T03:22:34.0185039+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-01-13T03:22:34.0185039+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "f708f354-d5c6-4387-bb2e-84157afcafd7",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "49a8aba8-bac6-45ab-95d7-0b45bf9a4e69",
"Sequence": 1,
"AncestorCategoryId": "7ce09a26-9d14-4452-b0a1-df0956bcbcff",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "3def05ef-54a0-422e-b4c9-c86f2e8c0d51",
"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": "3def05ef-54a0-422e-b4c9-c86f2e8c0d51",
"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": "f708f354-d5c6-4387-bb2e-84157afcafd7",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "49a8aba8-bac6-45ab-95d7-0b45bf9a4e69",
"Sequence": 1,
"AncestorCategoryId": "7ce09a26-9d14-4452-b0a1-df0956bcbcff",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "3def05ef-54a0-422e-b4c9-c86f2e8c0d51",
"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": "3def05ef-54a0-422e-b4c9-c86f2e8c0d51",
"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": "3feb293c-4706-4cdd-a8b5-b91ab989291b",
"CategoryId": "16be7ed0-1384-4c2f-a3db-7c296af4a251",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "4d3cfcde-00c3-428b-8b02-1ee59ef14301",
"Score": 1.0,
"State": 1
},
{
"Id": "4d3cfcde-00c3-428b-8b02-1ee59ef14301",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "08f22d0d-b76d-458d-9ff6-905915c11029",
"Questions": [
{
"Id": "6a7133a1-8a92-42f0-a16a-09b9eb00bd73",
"Answers": "sample string 2"
},
{
"Id": "6a7133a1-8a92-42f0-a16a-09b9eb00bd73",
"Answers": "sample string 2"
}
]
},
{
"Id": "08f22d0d-b76d-458d-9ff6-905915c11029",
"Questions": [
{
"Id": "6a7133a1-8a92-42f0-a16a-09b9eb00bd73",
"Answers": "sample string 2"
},
{
"Id": "6a7133a1-8a92-42f0-a16a-09b9eb00bd73",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "fc2db603-a282-4274-950b-145cb35eb396",
"ContentItemId": "f0aa5eaa-4b8b-4e9e-8ff8-c1446aa2748b",
"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-01-13T03:22:34.034132+00:00",
"RescheduleDate": "2026-01-13T03:22:34.034132+00:00"
},
{
"Id": "fc2db603-a282-4274-950b-145cb35eb396",
"ContentItemId": "f0aa5eaa-4b8b-4e9e-8ff8-c1446aa2748b",
"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-01-13T03:22:34.034132+00:00",
"RescheduleDate": "2026-01-13T03:22:34.034132+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": "73bc637f-eb52-4711-9730-b51b31a4b7b6",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-01-13T03:22:34.0653916+00:00",
"Registration": [
{
"Id": "2b566d88-7f80-4d67-a3d5-b0518ce5b84d",
"UserId": "b36f6119-4f54-44f5-934e-7db30048b164",
"IsCurrent": true,
"CenterId": "d6dfad04-101c-4178-9b53-8d8c1190b96d",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "946f42ca-7999-41ab-9237-c3a69eb521cc",
"EndDate": "2026-01-13T03:22:34.0185039+00:00",
"StartDate": "2026-01-13T03:22:34.0185039+00:00",
"SchedulePreferenceDate": "2026-01-13T03:22:34.0185039+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": "2b566d88-7f80-4d67-a3d5-b0518ce5b84d",
"UserId": "b36f6119-4f54-44f5-934e-7db30048b164",
"IsCurrent": true,
"CenterId": "d6dfad04-101c-4178-9b53-8d8c1190b96d",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "946f42ca-7999-41ab-9237-c3a69eb521cc",
"EndDate": "2026-01-13T03:22:34.0185039+00:00",
"StartDate": "2026-01-13T03:22:34.0185039+00:00",
"SchedulePreferenceDate": "2026-01-13T03:22:34.0185039+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-01-13T03:22:34.0185039+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "f708f354-d5c6-4387-bb2e-84157afcafd7",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "49a8aba8-bac6-45ab-95d7-0b45bf9a4e69",
"Sequence": 1,
"AncestorCategoryId": "7ce09a26-9d14-4452-b0a1-df0956bcbcff",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "3def05ef-54a0-422e-b4c9-c86f2e8c0d51",
"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": "3def05ef-54a0-422e-b4c9-c86f2e8c0d51",
"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": "f708f354-d5c6-4387-bb2e-84157afcafd7",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "49a8aba8-bac6-45ab-95d7-0b45bf9a4e69",
"Sequence": 1,
"AncestorCategoryId": "7ce09a26-9d14-4452-b0a1-df0956bcbcff",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "3def05ef-54a0-422e-b4c9-c86f2e8c0d51",
"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": "3def05ef-54a0-422e-b4c9-c86f2e8c0d51",
"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": "3feb293c-4706-4cdd-a8b5-b91ab989291b",
"CategoryId": "16be7ed0-1384-4c2f-a3db-7c296af4a251",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "4d3cfcde-00c3-428b-8b02-1ee59ef14301",
"Score": 1.0,
"State": 1
},
{
"Id": "4d3cfcde-00c3-428b-8b02-1ee59ef14301",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "08f22d0d-b76d-458d-9ff6-905915c11029",
"Questions": [
{
"Id": "6a7133a1-8a92-42f0-a16a-09b9eb00bd73",
"Answers": "sample string 2"
},
{
"Id": "6a7133a1-8a92-42f0-a16a-09b9eb00bd73",
"Answers": "sample string 2"
}
]
},
{
"Id": "08f22d0d-b76d-458d-9ff6-905915c11029",
"Questions": [
{
"Id": "6a7133a1-8a92-42f0-a16a-09b9eb00bd73",
"Answers": "sample string 2"
},
{
"Id": "6a7133a1-8a92-42f0-a16a-09b9eb00bd73",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "fc2db603-a282-4274-950b-145cb35eb396",
"ContentItemId": "f0aa5eaa-4b8b-4e9e-8ff8-c1446aa2748b",
"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-01-13T03:22:34.034132+00:00",
"RescheduleDate": "2026-01-13T03:22:34.034132+00:00"
},
{
"Id": "fc2db603-a282-4274-950b-145cb35eb396",
"ContentItemId": "f0aa5eaa-4b8b-4e9e-8ff8-c1446aa2748b",
"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-01-13T03:22:34.034132+00:00",
"RescheduleDate": "2026-01-13T03:22:34.034132+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
},
"StudentSpeakPlusLevelInfo": "sample string 5"
}