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": "db5daf98-7c6f-4b71-b88d-a196166e550d",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-08-18T18:39:01.4178918+00:00",
"Registration": {
"Id": "22cea1cf-6629-45ab-a05c-1b7b58ed3fa2",
"UserId": "160b0a03-0f30-4a48-b364-0de5b2d9410d",
"IsCurrent": true,
"CenterId": "98ead408-2a7d-40da-be1b-e4c57f51a6aa",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "b9ecf491-8601-4613-b77a-b96ed3f8a259",
"EndDate": "2026-08-18T18:39:01.4022627+00:00",
"StartDate": "2026-08-18T18:39:01.4022627+00:00",
"SchedulePreferenceDate": "2026-08-18T18:39:01.4022627+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-08-18T18:39:01.4022627+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "ec9bd980-3d03-4ce3-bc77-fdaf6d295bef",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "8e74af8d-f165-482e-ad18-551bc802c81f",
"Sequence": 1,
"AncestorCategoryId": "99afefe9-b768-41ef-a910-cb6cf9487f69",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "e1525329-b4af-4af0-a0ce-ec650f52bb10",
"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": "e1525329-b4af-4af0-a0ce-ec650f52bb10",
"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": "ec9bd980-3d03-4ce3-bc77-fdaf6d295bef",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "8e74af8d-f165-482e-ad18-551bc802c81f",
"Sequence": 1,
"AncestorCategoryId": "99afefe9-b768-41ef-a910-cb6cf9487f69",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "e1525329-b4af-4af0-a0ce-ec650f52bb10",
"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": "e1525329-b4af-4af0-a0ce-ec650f52bb10",
"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": "06aa889c-b44b-4610-aa02-69aa14eb6d84",
"CategoryId": "342482f6-ec6b-4a81-89aa-b6d0d9853731",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "523636b1-4e25-4e68-8acc-4622c32ccd6a",
"Score": 1.0,
"State": 1
},
{
"Id": "523636b1-4e25-4e68-8acc-4622c32ccd6a",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "ee443f43-00b5-419d-91fd-a962925b957a",
"Questions": [
{
"Id": "47efba33-f42c-41a0-a045-ce07c83c166f",
"Answers": "sample string 2"
},
{
"Id": "47efba33-f42c-41a0-a045-ce07c83c166f",
"Answers": "sample string 2"
}
]
},
{
"Id": "ee443f43-00b5-419d-91fd-a962925b957a",
"Questions": [
{
"Id": "47efba33-f42c-41a0-a045-ce07c83c166f",
"Answers": "sample string 2"
},
{
"Id": "47efba33-f42c-41a0-a045-ce07c83c166f",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "49635fe8-5b59-4658-b606-bfd2fac7a5bf",
"ContentItemId": "c0654031-20d1-47b3-9a6a-77532fc72355",
"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-08-18T18:39:01.4022627+00:00",
"RescheduleDate": "2026-08-18T18:39:01.4022627+00:00"
},
{
"Id": "49635fe8-5b59-4658-b606-bfd2fac7a5bf",
"ContentItemId": "c0654031-20d1-47b3-9a6a-77532fc72355",
"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-08-18T18:39:01.4022627+00:00",
"RescheduleDate": "2026-08-18T18:39:01.4022627+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}
text/json
Sample:
{
"UserId": "db5daf98-7c6f-4b71-b88d-a196166e550d",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-08-18T18:39:01.433511+00:00",
"Registration": {
"Id": "22cea1cf-6629-45ab-a05c-1b7b58ed3fa2",
"UserId": "160b0a03-0f30-4a48-b364-0de5b2d9410d",
"IsCurrent": true,
"CenterId": "98ead408-2a7d-40da-be1b-e4c57f51a6aa",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "b9ecf491-8601-4613-b77a-b96ed3f8a259",
"EndDate": "2026-08-18T18:39:01.4022627+00:00",
"StartDate": "2026-08-18T18:39:01.4022627+00:00",
"SchedulePreferenceDate": "2026-08-18T18:39:01.4022627+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-08-18T18:39:01.4022627+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "ec9bd980-3d03-4ce3-bc77-fdaf6d295bef",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "8e74af8d-f165-482e-ad18-551bc802c81f",
"Sequence": 1,
"AncestorCategoryId": "99afefe9-b768-41ef-a910-cb6cf9487f69",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "e1525329-b4af-4af0-a0ce-ec650f52bb10",
"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": "e1525329-b4af-4af0-a0ce-ec650f52bb10",
"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": "ec9bd980-3d03-4ce3-bc77-fdaf6d295bef",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "8e74af8d-f165-482e-ad18-551bc802c81f",
"Sequence": 1,
"AncestorCategoryId": "99afefe9-b768-41ef-a910-cb6cf9487f69",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "e1525329-b4af-4af0-a0ce-ec650f52bb10",
"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": "e1525329-b4af-4af0-a0ce-ec650f52bb10",
"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": "06aa889c-b44b-4610-aa02-69aa14eb6d84",
"CategoryId": "342482f6-ec6b-4a81-89aa-b6d0d9853731",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "523636b1-4e25-4e68-8acc-4622c32ccd6a",
"Score": 1.0,
"State": 1
},
{
"Id": "523636b1-4e25-4e68-8acc-4622c32ccd6a",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "ee443f43-00b5-419d-91fd-a962925b957a",
"Questions": [
{
"Id": "47efba33-f42c-41a0-a045-ce07c83c166f",
"Answers": "sample string 2"
},
{
"Id": "47efba33-f42c-41a0-a045-ce07c83c166f",
"Answers": "sample string 2"
}
]
},
{
"Id": "ee443f43-00b5-419d-91fd-a962925b957a",
"Questions": [
{
"Id": "47efba33-f42c-41a0-a045-ce07c83c166f",
"Answers": "sample string 2"
},
{
"Id": "47efba33-f42c-41a0-a045-ce07c83c166f",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "49635fe8-5b59-4658-b606-bfd2fac7a5bf",
"ContentItemId": "c0654031-20d1-47b3-9a6a-77532fc72355",
"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-08-18T18:39:01.4022627+00:00",
"RescheduleDate": "2026-08-18T18:39:01.4022627+00:00"
},
{
"Id": "49635fe8-5b59-4658-b606-bfd2fac7a5bf",
"ContentItemId": "c0654031-20d1-47b3-9a6a-77532fc72355",
"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-08-18T18:39:01.4022627+00:00",
"RescheduleDate": "2026-08-18T18:39:01.4022627+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}