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": "0e2a483c-0b0d-4a2e-bc9d-80d74edda815",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-11-19T07:51:37.7135515+00:00",
"Registration": [
{
"Id": "8f132e66-f101-4614-acfc-ef6dd2af5ba1",
"UserId": "b8f07acb-976b-4e92-b617-bca7b610e4ae",
"IsCurrent": true,
"CenterId": "5c17a39c-43d3-47d4-8df0-45daedc4f4cf",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "c8ec4a57-92b1-482e-a2ef-1923ed085811",
"EndDate": "2026-11-19T07:51:37.7135515+00:00",
"StartDate": "2026-11-19T07:51:37.7135515+00:00",
"SchedulePreferenceDate": "2026-11-19T07:51:37.7135515+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": "8f132e66-f101-4614-acfc-ef6dd2af5ba1",
"UserId": "b8f07acb-976b-4e92-b617-bca7b610e4ae",
"IsCurrent": true,
"CenterId": "5c17a39c-43d3-47d4-8df0-45daedc4f4cf",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "c8ec4a57-92b1-482e-a2ef-1923ed085811",
"EndDate": "2026-11-19T07:51:37.7135515+00:00",
"StartDate": "2026-11-19T07:51:37.7135515+00:00",
"SchedulePreferenceDate": "2026-11-19T07:51:37.7135515+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-11-19T07:51:37.7135515+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "3de51c8d-c4fe-47a4-a1a2-e41597806c0a",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "6d308fc3-42b7-4523-ad6d-bd49a9debbe5",
"Sequence": 1,
"AncestorCategoryId": "e2c4f061-d2e5-44e0-a16d-112bbd80803f",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "5ae0abce-3904-4356-a88f-995e9a0a250e",
"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": "5ae0abce-3904-4356-a88f-995e9a0a250e",
"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": "3de51c8d-c4fe-47a4-a1a2-e41597806c0a",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "6d308fc3-42b7-4523-ad6d-bd49a9debbe5",
"Sequence": 1,
"AncestorCategoryId": "e2c4f061-d2e5-44e0-a16d-112bbd80803f",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "5ae0abce-3904-4356-a88f-995e9a0a250e",
"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": "5ae0abce-3904-4356-a88f-995e9a0a250e",
"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": "48d57af1-5a2d-43c4-8d02-1667dcd38e5a",
"CategoryId": "bd16b7e9-b200-4184-8315-7031cd5fa02e",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "35b45dac-c11b-4d40-8374-9c00bd58c6aa",
"Score": 1.0,
"State": 1
},
{
"Id": "35b45dac-c11b-4d40-8374-9c00bd58c6aa",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "999e47c9-8f24-453a-8f79-eeb5a50791f5",
"Questions": [
{
"Id": "e91eed52-ffa3-4b89-bfac-72bbb1535945",
"Answers": "sample string 2"
},
{
"Id": "e91eed52-ffa3-4b89-bfac-72bbb1535945",
"Answers": "sample string 2"
}
]
},
{
"Id": "999e47c9-8f24-453a-8f79-eeb5a50791f5",
"Questions": [
{
"Id": "e91eed52-ffa3-4b89-bfac-72bbb1535945",
"Answers": "sample string 2"
},
{
"Id": "e91eed52-ffa3-4b89-bfac-72bbb1535945",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "0c66b4b5-d20b-41f3-8158-f597e9826e3c",
"ContentItemId": "0818b6e8-67ae-4e52-b18d-1722b6635453",
"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-11-19T07:51:37.7135515+00:00",
"RescheduleDate": "2026-11-19T07:51:37.7135515+00:00"
},
{
"Id": "0c66b4b5-d20b-41f3-8158-f597e9826e3c",
"ContentItemId": "0818b6e8-67ae-4e52-b18d-1722b6635453",
"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-11-19T07:51:37.7135515+00:00",
"RescheduleDate": "2026-11-19T07:51:37.7135515+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": "0e2a483c-0b0d-4a2e-bc9d-80d74edda815",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-11-19T07:51:37.7447965+00:00",
"Registration": [
{
"Id": "8f132e66-f101-4614-acfc-ef6dd2af5ba1",
"UserId": "b8f07acb-976b-4e92-b617-bca7b610e4ae",
"IsCurrent": true,
"CenterId": "5c17a39c-43d3-47d4-8df0-45daedc4f4cf",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "c8ec4a57-92b1-482e-a2ef-1923ed085811",
"EndDate": "2026-11-19T07:51:37.7135515+00:00",
"StartDate": "2026-11-19T07:51:37.7135515+00:00",
"SchedulePreferenceDate": "2026-11-19T07:51:37.7135515+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": "8f132e66-f101-4614-acfc-ef6dd2af5ba1",
"UserId": "b8f07acb-976b-4e92-b617-bca7b610e4ae",
"IsCurrent": true,
"CenterId": "5c17a39c-43d3-47d4-8df0-45daedc4f4cf",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "c8ec4a57-92b1-482e-a2ef-1923ed085811",
"EndDate": "2026-11-19T07:51:37.7135515+00:00",
"StartDate": "2026-11-19T07:51:37.7135515+00:00",
"SchedulePreferenceDate": "2026-11-19T07:51:37.7135515+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-11-19T07:51:37.7135515+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "3de51c8d-c4fe-47a4-a1a2-e41597806c0a",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "6d308fc3-42b7-4523-ad6d-bd49a9debbe5",
"Sequence": 1,
"AncestorCategoryId": "e2c4f061-d2e5-44e0-a16d-112bbd80803f",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "5ae0abce-3904-4356-a88f-995e9a0a250e",
"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": "5ae0abce-3904-4356-a88f-995e9a0a250e",
"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": "3de51c8d-c4fe-47a4-a1a2-e41597806c0a",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "6d308fc3-42b7-4523-ad6d-bd49a9debbe5",
"Sequence": 1,
"AncestorCategoryId": "e2c4f061-d2e5-44e0-a16d-112bbd80803f",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "5ae0abce-3904-4356-a88f-995e9a0a250e",
"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": "5ae0abce-3904-4356-a88f-995e9a0a250e",
"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": "48d57af1-5a2d-43c4-8d02-1667dcd38e5a",
"CategoryId": "bd16b7e9-b200-4184-8315-7031cd5fa02e",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "35b45dac-c11b-4d40-8374-9c00bd58c6aa",
"Score": 1.0,
"State": 1
},
{
"Id": "35b45dac-c11b-4d40-8374-9c00bd58c6aa",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "999e47c9-8f24-453a-8f79-eeb5a50791f5",
"Questions": [
{
"Id": "e91eed52-ffa3-4b89-bfac-72bbb1535945",
"Answers": "sample string 2"
},
{
"Id": "e91eed52-ffa3-4b89-bfac-72bbb1535945",
"Answers": "sample string 2"
}
]
},
{
"Id": "999e47c9-8f24-453a-8f79-eeb5a50791f5",
"Questions": [
{
"Id": "e91eed52-ffa3-4b89-bfac-72bbb1535945",
"Answers": "sample string 2"
},
{
"Id": "e91eed52-ffa3-4b89-bfac-72bbb1535945",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "0c66b4b5-d20b-41f3-8158-f597e9826e3c",
"ContentItemId": "0818b6e8-67ae-4e52-b18d-1722b6635453",
"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-11-19T07:51:37.7135515+00:00",
"RescheduleDate": "2026-11-19T07:51:37.7135515+00:00"
},
{
"Id": "0c66b4b5-d20b-41f3-8158-f597e9826e3c",
"ContentItemId": "0818b6e8-67ae-4e52-b18d-1722b6635453",
"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-11-19T07:51:37.7135515+00:00",
"RescheduleDate": "2026-11-19T07:51:37.7135515+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
},
"StudentSpeakPlusLevelInfo": "sample string 5"
}