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": "763c6ddb-9695-4f89-b3d4-bc4e13971ea3",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-11-22T08:11:04.7697879+00:00",
"Registration": [
{
"Id": "e6c2add9-54e1-4b28-a986-86ce7de95702",
"UserId": "88c2bd0b-fabf-48ff-9f6a-5454308e9114",
"IsCurrent": true,
"CenterId": "30988f02-677d-417e-864d-38167a23576b",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "7b18f433-c93b-4133-9f1d-e4fe016e49a9",
"EndDate": "2026-11-22T08:11:04.7697879+00:00",
"StartDate": "2026-11-22T08:11:04.7697879+00:00",
"SchedulePreferenceDate": "2026-11-22T08:11:04.7697879+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": "e6c2add9-54e1-4b28-a986-86ce7de95702",
"UserId": "88c2bd0b-fabf-48ff-9f6a-5454308e9114",
"IsCurrent": true,
"CenterId": "30988f02-677d-417e-864d-38167a23576b",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "7b18f433-c93b-4133-9f1d-e4fe016e49a9",
"EndDate": "2026-11-22T08:11:04.7697879+00:00",
"StartDate": "2026-11-22T08:11:04.7697879+00:00",
"SchedulePreferenceDate": "2026-11-22T08:11:04.7697879+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-22T08:11:04.7697879+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "d3a4d24b-8342-4d97-a8e7-d1de1d8513c5",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "5dbcb075-d5aa-4e36-92ae-872abf435888",
"Sequence": 1,
"AncestorCategoryId": "73248ca7-1969-43a6-829a-130726f47da1",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "ebaf96c8-b810-4256-af24-ba1e28756240",
"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": "ebaf96c8-b810-4256-af24-ba1e28756240",
"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": "d3a4d24b-8342-4d97-a8e7-d1de1d8513c5",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "5dbcb075-d5aa-4e36-92ae-872abf435888",
"Sequence": 1,
"AncestorCategoryId": "73248ca7-1969-43a6-829a-130726f47da1",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "ebaf96c8-b810-4256-af24-ba1e28756240",
"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": "ebaf96c8-b810-4256-af24-ba1e28756240",
"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": "3cfe51cc-dc72-47aa-a15d-1e1ca1168317",
"CategoryId": "10c88e20-e604-456f-a24e-f95a19fee32e",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "be6b32aa-063f-42f9-ac84-346220489c45",
"Score": 1.0,
"State": 1
},
{
"Id": "be6b32aa-063f-42f9-ac84-346220489c45",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "d1ed707f-7a2d-4f4c-bcf9-118c0ba1d9de",
"Questions": [
{
"Id": "b52f4a62-879a-4481-992d-56c457df19b4",
"Answers": "sample string 2"
},
{
"Id": "b52f4a62-879a-4481-992d-56c457df19b4",
"Answers": "sample string 2"
}
]
},
{
"Id": "d1ed707f-7a2d-4f4c-bcf9-118c0ba1d9de",
"Questions": [
{
"Id": "b52f4a62-879a-4481-992d-56c457df19b4",
"Answers": "sample string 2"
},
{
"Id": "b52f4a62-879a-4481-992d-56c457df19b4",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "90d79481-407a-4142-97c8-939ef68fda97",
"ContentItemId": "de4c3625-c4d7-4038-9a44-11b734a5d7c6",
"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-22T08:11:04.7697879+00:00",
"RescheduleDate": "2026-11-22T08:11:04.7697879+00:00"
},
{
"Id": "90d79481-407a-4142-97c8-939ef68fda97",
"ContentItemId": "de4c3625-c4d7-4038-9a44-11b734a5d7c6",
"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-22T08:11:04.7697879+00:00",
"RescheduleDate": "2026-11-22T08:11:04.7697879+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": "763c6ddb-9695-4f89-b3d4-bc4e13971ea3",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-11-22T08:11:04.816663+00:00",
"Registration": [
{
"Id": "e6c2add9-54e1-4b28-a986-86ce7de95702",
"UserId": "88c2bd0b-fabf-48ff-9f6a-5454308e9114",
"IsCurrent": true,
"CenterId": "30988f02-677d-417e-864d-38167a23576b",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "7b18f433-c93b-4133-9f1d-e4fe016e49a9",
"EndDate": "2026-11-22T08:11:04.7697879+00:00",
"StartDate": "2026-11-22T08:11:04.7697879+00:00",
"SchedulePreferenceDate": "2026-11-22T08:11:04.7697879+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": "e6c2add9-54e1-4b28-a986-86ce7de95702",
"UserId": "88c2bd0b-fabf-48ff-9f6a-5454308e9114",
"IsCurrent": true,
"CenterId": "30988f02-677d-417e-864d-38167a23576b",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "7b18f433-c93b-4133-9f1d-e4fe016e49a9",
"EndDate": "2026-11-22T08:11:04.7697879+00:00",
"StartDate": "2026-11-22T08:11:04.7697879+00:00",
"SchedulePreferenceDate": "2026-11-22T08:11:04.7697879+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-22T08:11:04.7697879+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "d3a4d24b-8342-4d97-a8e7-d1de1d8513c5",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "5dbcb075-d5aa-4e36-92ae-872abf435888",
"Sequence": 1,
"AncestorCategoryId": "73248ca7-1969-43a6-829a-130726f47da1",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "ebaf96c8-b810-4256-af24-ba1e28756240",
"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": "ebaf96c8-b810-4256-af24-ba1e28756240",
"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": "d3a4d24b-8342-4d97-a8e7-d1de1d8513c5",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "5dbcb075-d5aa-4e36-92ae-872abf435888",
"Sequence": 1,
"AncestorCategoryId": "73248ca7-1969-43a6-829a-130726f47da1",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "ebaf96c8-b810-4256-af24-ba1e28756240",
"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": "ebaf96c8-b810-4256-af24-ba1e28756240",
"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": "3cfe51cc-dc72-47aa-a15d-1e1ca1168317",
"CategoryId": "10c88e20-e604-456f-a24e-f95a19fee32e",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "be6b32aa-063f-42f9-ac84-346220489c45",
"Score": 1.0,
"State": 1
},
{
"Id": "be6b32aa-063f-42f9-ac84-346220489c45",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "d1ed707f-7a2d-4f4c-bcf9-118c0ba1d9de",
"Questions": [
{
"Id": "b52f4a62-879a-4481-992d-56c457df19b4",
"Answers": "sample string 2"
},
{
"Id": "b52f4a62-879a-4481-992d-56c457df19b4",
"Answers": "sample string 2"
}
]
},
{
"Id": "d1ed707f-7a2d-4f4c-bcf9-118c0ba1d9de",
"Questions": [
{
"Id": "b52f4a62-879a-4481-992d-56c457df19b4",
"Answers": "sample string 2"
},
{
"Id": "b52f4a62-879a-4481-992d-56c457df19b4",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "90d79481-407a-4142-97c8-939ef68fda97",
"ContentItemId": "de4c3625-c4d7-4038-9a44-11b734a5d7c6",
"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-22T08:11:04.7697879+00:00",
"RescheduleDate": "2026-11-22T08:11:04.7697879+00:00"
},
{
"Id": "90d79481-407a-4142-97c8-939ef68fda97",
"ContentItemId": "de4c3625-c4d7-4038-9a44-11b734a5d7c6",
"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-22T08:11:04.7697879+00:00",
"RescheduleDate": "2026-11-22T08:11:04.7697879+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
},
"StudentSpeakPlusLevelInfo": "sample string 5"
}