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": "fa60952e-aa75-4068-ac8e-10c6bcecc282",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-07-23T19:22:41.8287078+00:00",
"Registration": {
"Id": "3e447513-d588-4ed1-9b79-2112a75e8eda",
"UserId": "fb44a3b8-afe3-4927-940c-644a11795c0d",
"IsCurrent": true,
"CenterId": "bbff6246-1fc4-433e-b373-210cacefa02f",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "ee4507dc-ea06-4abe-9c9c-6cafbb12ee45",
"EndDate": "2026-07-23T19:22:41.8130871+00:00",
"StartDate": "2026-07-23T19:22:41.8130871+00:00",
"SchedulePreferenceDate": "2026-07-23T19:22:41.8130871+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-07-23T19:22:41.8130871+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "5ed8e6cb-e6f4-4e3d-a9ec-71e6196e12cd",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "d7c2243b-d56d-47af-b95b-1c1450579346",
"Sequence": 1,
"AncestorCategoryId": "c4d3991e-1431-48a6-8401-339b4549d388",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "091eccdf-637c-4a47-b7eb-468e1c775b05",
"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": "091eccdf-637c-4a47-b7eb-468e1c775b05",
"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": "5ed8e6cb-e6f4-4e3d-a9ec-71e6196e12cd",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "d7c2243b-d56d-47af-b95b-1c1450579346",
"Sequence": 1,
"AncestorCategoryId": "c4d3991e-1431-48a6-8401-339b4549d388",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "091eccdf-637c-4a47-b7eb-468e1c775b05",
"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": "091eccdf-637c-4a47-b7eb-468e1c775b05",
"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": "15dd01ce-b4b9-4fca-b3b9-87f3f7badfc0",
"CategoryId": "594858a7-1a3b-4b79-8727-fe4a05846c3f",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "dc08f454-251e-47c9-ad96-93e0d35b12fe",
"Score": 1.0,
"State": 1
},
{
"Id": "dc08f454-251e-47c9-ad96-93e0d35b12fe",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "a681dad2-bcb3-443d-980d-00aa8710d3e5",
"Questions": [
{
"Id": "b72fa203-4d9d-43cf-b266-312cc98b038d",
"Answers": "sample string 2"
},
{
"Id": "b72fa203-4d9d-43cf-b266-312cc98b038d",
"Answers": "sample string 2"
}
]
},
{
"Id": "a681dad2-bcb3-443d-980d-00aa8710d3e5",
"Questions": [
{
"Id": "b72fa203-4d9d-43cf-b266-312cc98b038d",
"Answers": "sample string 2"
},
{
"Id": "b72fa203-4d9d-43cf-b266-312cc98b038d",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "91b44155-dda9-4c31-9ad5-5c6446dead13",
"ContentItemId": "20b2a2c0-42b4-48a0-bb0e-2e23f8507cd9",
"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-07-23T19:22:41.8130871+00:00",
"RescheduleDate": "2026-07-23T19:22:41.8130871+00:00"
},
{
"Id": "91b44155-dda9-4c31-9ad5-5c6446dead13",
"ContentItemId": "20b2a2c0-42b4-48a0-bb0e-2e23f8507cd9",
"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-07-23T19:22:41.8130871+00:00",
"RescheduleDate": "2026-07-23T19:22:41.8130871+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}
text/json
Sample:
{
"UserId": "fa60952e-aa75-4068-ac8e-10c6bcecc282",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-07-23T19:22:42.0630838+00:00",
"Registration": {
"Id": "3e447513-d588-4ed1-9b79-2112a75e8eda",
"UserId": "fb44a3b8-afe3-4927-940c-644a11795c0d",
"IsCurrent": true,
"CenterId": "bbff6246-1fc4-433e-b373-210cacefa02f",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "ee4507dc-ea06-4abe-9c9c-6cafbb12ee45",
"EndDate": "2026-07-23T19:22:41.8130871+00:00",
"StartDate": "2026-07-23T19:22:41.8130871+00:00",
"SchedulePreferenceDate": "2026-07-23T19:22:41.8130871+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-07-23T19:22:41.8130871+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "5ed8e6cb-e6f4-4e3d-a9ec-71e6196e12cd",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "d7c2243b-d56d-47af-b95b-1c1450579346",
"Sequence": 1,
"AncestorCategoryId": "c4d3991e-1431-48a6-8401-339b4549d388",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "091eccdf-637c-4a47-b7eb-468e1c775b05",
"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": "091eccdf-637c-4a47-b7eb-468e1c775b05",
"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": "5ed8e6cb-e6f4-4e3d-a9ec-71e6196e12cd",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "d7c2243b-d56d-47af-b95b-1c1450579346",
"Sequence": 1,
"AncestorCategoryId": "c4d3991e-1431-48a6-8401-339b4549d388",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "091eccdf-637c-4a47-b7eb-468e1c775b05",
"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": "091eccdf-637c-4a47-b7eb-468e1c775b05",
"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": "15dd01ce-b4b9-4fca-b3b9-87f3f7badfc0",
"CategoryId": "594858a7-1a3b-4b79-8727-fe4a05846c3f",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "dc08f454-251e-47c9-ad96-93e0d35b12fe",
"Score": 1.0,
"State": 1
},
{
"Id": "dc08f454-251e-47c9-ad96-93e0d35b12fe",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "a681dad2-bcb3-443d-980d-00aa8710d3e5",
"Questions": [
{
"Id": "b72fa203-4d9d-43cf-b266-312cc98b038d",
"Answers": "sample string 2"
},
{
"Id": "b72fa203-4d9d-43cf-b266-312cc98b038d",
"Answers": "sample string 2"
}
]
},
{
"Id": "a681dad2-bcb3-443d-980d-00aa8710d3e5",
"Questions": [
{
"Id": "b72fa203-4d9d-43cf-b266-312cc98b038d",
"Answers": "sample string 2"
},
{
"Id": "b72fa203-4d9d-43cf-b266-312cc98b038d",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "91b44155-dda9-4c31-9ad5-5c6446dead13",
"ContentItemId": "20b2a2c0-42b4-48a0-bb0e-2e23f8507cd9",
"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-07-23T19:22:41.8130871+00:00",
"RescheduleDate": "2026-07-23T19:22:41.8130871+00:00"
},
{
"Id": "91b44155-dda9-4c31-9ad5-5c6446dead13",
"ContentItemId": "20b2a2c0-42b4-48a0-bb0e-2e23f8507cd9",
"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-07-23T19:22:41.8130871+00:00",
"RescheduleDate": "2026-07-23T19:22:41.8130871+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}