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": "4bf81596-3920-4098-95c3-416bed60fb15",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-01-28T11:39:05.6425349+00:00",
"Registration": {
"Id": "943424c6-8a77-47f0-90b0-5856c24e0264",
"UserId": "e7cf2d36-7ff0-4869-950f-026de7800244",
"IsCurrent": true,
"CenterId": "048a4079-bc72-4664-a431-ff2e7c69d58b",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "17a4d094-f197-4c7b-93e0-3dd78c8de636",
"EndDate": "2026-01-28T11:39:05.6267056+00:00",
"StartDate": "2026-01-28T11:39:05.6267056+00:00",
"SchedulePreferenceDate": "2026-01-28T11:39:05.6267056+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-01-28T11:39:05.6267056+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "08f7827e-b03d-4328-9215-7f256bc4c3f6",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "dfb2b7e3-4f18-46df-bac4-1ab0ef2a72ca",
"Sequence": 1,
"AncestorCategoryId": "954c80ee-ede0-47b6-8e81-9b73c867d898",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "486a0978-033f-4ef7-a8b0-33078af78f80",
"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": "486a0978-033f-4ef7-a8b0-33078af78f80",
"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": "08f7827e-b03d-4328-9215-7f256bc4c3f6",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "dfb2b7e3-4f18-46df-bac4-1ab0ef2a72ca",
"Sequence": 1,
"AncestorCategoryId": "954c80ee-ede0-47b6-8e81-9b73c867d898",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "486a0978-033f-4ef7-a8b0-33078af78f80",
"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": "486a0978-033f-4ef7-a8b0-33078af78f80",
"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": "2db834fb-3e9e-44d2-be34-2f3864ea478d",
"CategoryId": "0b6dfbea-93b2-4c95-8789-816cef5088f7",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "722c63e0-5afd-479a-b8b0-f5c1f3256e5d",
"Score": 1.0,
"State": 1
},
{
"Id": "722c63e0-5afd-479a-b8b0-f5c1f3256e5d",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "93cc6988-f80b-46fd-a31d-34d1583a7d64",
"Questions": [
{
"Id": "ac22102d-fd79-41ea-b180-b34e1625155b",
"Answers": "sample string 2"
},
{
"Id": "ac22102d-fd79-41ea-b180-b34e1625155b",
"Answers": "sample string 2"
}
]
},
{
"Id": "93cc6988-f80b-46fd-a31d-34d1583a7d64",
"Questions": [
{
"Id": "ac22102d-fd79-41ea-b180-b34e1625155b",
"Answers": "sample string 2"
},
{
"Id": "ac22102d-fd79-41ea-b180-b34e1625155b",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "37aa6332-edee-48b6-9185-a479441304aa",
"ContentItemId": "822a0681-84c3-488a-896f-5359a9bc56ac",
"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-01-28T11:39:05.6267056+00:00",
"RescheduleDate": "2026-01-28T11:39:05.6267056+00:00"
},
{
"Id": "37aa6332-edee-48b6-9185-a479441304aa",
"ContentItemId": "822a0681-84c3-488a-896f-5359a9bc56ac",
"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-01-28T11:39:05.6267056+00:00",
"RescheduleDate": "2026-01-28T11:39:05.6267056+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}
text/json
Sample:
{
"UserId": "4bf81596-3920-4098-95c3-416bed60fb15",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-01-28T11:39:05.6892041+00:00",
"Registration": {
"Id": "943424c6-8a77-47f0-90b0-5856c24e0264",
"UserId": "e7cf2d36-7ff0-4869-950f-026de7800244",
"IsCurrent": true,
"CenterId": "048a4079-bc72-4664-a431-ff2e7c69d58b",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "17a4d094-f197-4c7b-93e0-3dd78c8de636",
"EndDate": "2026-01-28T11:39:05.6267056+00:00",
"StartDate": "2026-01-28T11:39:05.6267056+00:00",
"SchedulePreferenceDate": "2026-01-28T11:39:05.6267056+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-01-28T11:39:05.6267056+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "08f7827e-b03d-4328-9215-7f256bc4c3f6",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "dfb2b7e3-4f18-46df-bac4-1ab0ef2a72ca",
"Sequence": 1,
"AncestorCategoryId": "954c80ee-ede0-47b6-8e81-9b73c867d898",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "486a0978-033f-4ef7-a8b0-33078af78f80",
"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": "486a0978-033f-4ef7-a8b0-33078af78f80",
"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": "08f7827e-b03d-4328-9215-7f256bc4c3f6",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "dfb2b7e3-4f18-46df-bac4-1ab0ef2a72ca",
"Sequence": 1,
"AncestorCategoryId": "954c80ee-ede0-47b6-8e81-9b73c867d898",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "486a0978-033f-4ef7-a8b0-33078af78f80",
"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": "486a0978-033f-4ef7-a8b0-33078af78f80",
"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": "2db834fb-3e9e-44d2-be34-2f3864ea478d",
"CategoryId": "0b6dfbea-93b2-4c95-8789-816cef5088f7",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "722c63e0-5afd-479a-b8b0-f5c1f3256e5d",
"Score": 1.0,
"State": 1
},
{
"Id": "722c63e0-5afd-479a-b8b0-f5c1f3256e5d",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "93cc6988-f80b-46fd-a31d-34d1583a7d64",
"Questions": [
{
"Id": "ac22102d-fd79-41ea-b180-b34e1625155b",
"Answers": "sample string 2"
},
{
"Id": "ac22102d-fd79-41ea-b180-b34e1625155b",
"Answers": "sample string 2"
}
]
},
{
"Id": "93cc6988-f80b-46fd-a31d-34d1583a7d64",
"Questions": [
{
"Id": "ac22102d-fd79-41ea-b180-b34e1625155b",
"Answers": "sample string 2"
},
{
"Id": "ac22102d-fd79-41ea-b180-b34e1625155b",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "37aa6332-edee-48b6-9185-a479441304aa",
"ContentItemId": "822a0681-84c3-488a-896f-5359a9bc56ac",
"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-01-28T11:39:05.6267056+00:00",
"RescheduleDate": "2026-01-28T11:39:05.6267056+00:00"
},
{
"Id": "37aa6332-edee-48b6-9185-a479441304aa",
"ContentItemId": "822a0681-84c3-488a-896f-5359a9bc56ac",
"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-01-28T11:39:05.6267056+00:00",
"RescheduleDate": "2026-01-28T11:39:05.6267056+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}