GET 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.Views.UserStateBackwardCompatibleViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId | globally unique identifier |
None. |
|
| IsNewUser | boolean |
None. |
|
| UserName | string |
None. |
|
| PrivacyPolicyApprove | boolean |
None. |
|
| ServerTime | date |
None. |
|
| Registration | 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. |
Response Formats
application/json
Sample:
{
"UserId": "684a7265-fbca-4284-9628-1ac8f1ddf892",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-09-28T16:10:50.8391295+00:00",
"Registration": {
"Id": "375ccea1-ef87-4bb1-b085-80ea19ffe7eb",
"UserId": "c6e5807f-c2c2-4816-a0e0-663af520783a",
"IsCurrent": true,
"CenterId": "4ac71edf-de99-4a87-92f5-f9e34a124a67",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "3355bfe3-87c0-4a48-9c04-349b808597fa",
"EndDate": "2026-09-28T16:10:50.8235072+00:00",
"StartDate": "2026-09-28T16:10:50.8235072+00:00",
"SchedulePreferenceDate": "2026-09-28T16:10:50.8235072+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-28T16:10:50.8235072+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "cd50bf98-967f-41bc-9552-8880c12fe74f",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "aed29c67-a395-477d-81a5-da8cafb686e7",
"Sequence": 1,
"AncestorCategoryId": "13513b16-5afc-4402-8681-5c89a0b2aa37",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "dbfafcd2-6bcb-4836-a8d2-16e63ee080a2",
"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": "dbfafcd2-6bcb-4836-a8d2-16e63ee080a2",
"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": "cd50bf98-967f-41bc-9552-8880c12fe74f",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "aed29c67-a395-477d-81a5-da8cafb686e7",
"Sequence": 1,
"AncestorCategoryId": "13513b16-5afc-4402-8681-5c89a0b2aa37",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "dbfafcd2-6bcb-4836-a8d2-16e63ee080a2",
"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": "dbfafcd2-6bcb-4836-a8d2-16e63ee080a2",
"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": "09c1d8f4-9a5d-4aec-b8fa-3c46f324791f",
"CategoryId": "9ab00ca6-491c-4ef7-84cb-9974183af766",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "fd027bcf-46da-4923-9f05-88a300084f9a",
"Score": 1.0,
"State": 1
},
{
"Id": "fd027bcf-46da-4923-9f05-88a300084f9a",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "80323257-bb4f-4655-b3aa-81507afaa2c1",
"Questions": [
{
"Id": "8b7207ca-2d50-4b53-9970-70bcea1f6965",
"Answers": "sample string 2"
},
{
"Id": "8b7207ca-2d50-4b53-9970-70bcea1f6965",
"Answers": "sample string 2"
}
]
},
{
"Id": "80323257-bb4f-4655-b3aa-81507afaa2c1",
"Questions": [
{
"Id": "8b7207ca-2d50-4b53-9970-70bcea1f6965",
"Answers": "sample string 2"
},
{
"Id": "8b7207ca-2d50-4b53-9970-70bcea1f6965",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "cdf6ccf7-27d5-41d8-bfe7-db13400fface",
"ContentItemId": "fbb5d22e-c5ba-44dc-ae1f-f6b84fe132b6",
"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-28T16:10:50.8235072+00:00",
"RescheduleDate": "2026-09-28T16:10:50.8235072+00:00"
},
{
"Id": "cdf6ccf7-27d5-41d8-bfe7-db13400fface",
"ContentItemId": "fbb5d22e-c5ba-44dc-ae1f-f6b84fe132b6",
"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-28T16:10:50.8235072+00:00",
"RescheduleDate": "2026-09-28T16:10:50.8235072+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}
text/json
Sample:
{
"UserId": "684a7265-fbca-4284-9628-1ac8f1ddf892",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-09-28T16:10:50.8547546+00:00",
"Registration": {
"Id": "375ccea1-ef87-4bb1-b085-80ea19ffe7eb",
"UserId": "c6e5807f-c2c2-4816-a0e0-663af520783a",
"IsCurrent": true,
"CenterId": "4ac71edf-de99-4a87-92f5-f9e34a124a67",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "3355bfe3-87c0-4a48-9c04-349b808597fa",
"EndDate": "2026-09-28T16:10:50.8235072+00:00",
"StartDate": "2026-09-28T16:10:50.8235072+00:00",
"SchedulePreferenceDate": "2026-09-28T16:10:50.8235072+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-28T16:10:50.8235072+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "cd50bf98-967f-41bc-9552-8880c12fe74f",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "aed29c67-a395-477d-81a5-da8cafb686e7",
"Sequence": 1,
"AncestorCategoryId": "13513b16-5afc-4402-8681-5c89a0b2aa37",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "dbfafcd2-6bcb-4836-a8d2-16e63ee080a2",
"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": "dbfafcd2-6bcb-4836-a8d2-16e63ee080a2",
"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": "cd50bf98-967f-41bc-9552-8880c12fe74f",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "aed29c67-a395-477d-81a5-da8cafb686e7",
"Sequence": 1,
"AncestorCategoryId": "13513b16-5afc-4402-8681-5c89a0b2aa37",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "dbfafcd2-6bcb-4836-a8d2-16e63ee080a2",
"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": "dbfafcd2-6bcb-4836-a8d2-16e63ee080a2",
"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": "09c1d8f4-9a5d-4aec-b8fa-3c46f324791f",
"CategoryId": "9ab00ca6-491c-4ef7-84cb-9974183af766",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "fd027bcf-46da-4923-9f05-88a300084f9a",
"Score": 1.0,
"State": 1
},
{
"Id": "fd027bcf-46da-4923-9f05-88a300084f9a",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "80323257-bb4f-4655-b3aa-81507afaa2c1",
"Questions": [
{
"Id": "8b7207ca-2d50-4b53-9970-70bcea1f6965",
"Answers": "sample string 2"
},
{
"Id": "8b7207ca-2d50-4b53-9970-70bcea1f6965",
"Answers": "sample string 2"
}
]
},
{
"Id": "80323257-bb4f-4655-b3aa-81507afaa2c1",
"Questions": [
{
"Id": "8b7207ca-2d50-4b53-9970-70bcea1f6965",
"Answers": "sample string 2"
},
{
"Id": "8b7207ca-2d50-4b53-9970-70bcea1f6965",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "cdf6ccf7-27d5-41d8-bfe7-db13400fface",
"ContentItemId": "fbb5d22e-c5ba-44dc-ae1f-f6b84fe132b6",
"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-28T16:10:50.8235072+00:00",
"RescheduleDate": "2026-09-28T16:10:50.8235072+00:00"
},
{
"Id": "cdf6ccf7-27d5-41d8-bfe7-db13400fface",
"ContentItemId": "fbb5d22e-c5ba-44dc-ae1f-f6b84fe132b6",
"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-28T16:10:50.8235072+00:00",
"RescheduleDate": "2026-09-28T16:10:50.8235072+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}