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": "712ae4e4-7a8d-47fa-b770-3c388e92b1db",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-08-06T22:51:17.5889878+00:00",
"Registration": {
"Id": "463762fb-f1c0-4acb-a4e6-c039ae308010",
"UserId": "08dcd0e2-5621-4163-a3db-ee62a5c6a6a6",
"IsCurrent": true,
"CenterId": "9fc60206-cb19-43aa-9de8-3d420947b8f1",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "efa6f4ac-6dbc-4098-a977-e02c9cf4f0c4",
"EndDate": "2026-08-06T22:51:17.573368+00:00",
"StartDate": "2026-08-06T22:51:17.573368+00:00",
"SchedulePreferenceDate": "2026-08-06T22:51:17.573368+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-06T22:51:17.573368+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "c63596a5-47fb-485b-9cfe-ea9301d7a99d",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "56f1d3c1-df61-4174-bfc6-aeb17945a621",
"Sequence": 1,
"AncestorCategoryId": "c661fa8b-2beb-4d00-89f9-f95ee9d58e8f",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "4ca2103a-f415-4c0b-9e83-b72a8ad64aaa",
"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": "4ca2103a-f415-4c0b-9e83-b72a8ad64aaa",
"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": "c63596a5-47fb-485b-9cfe-ea9301d7a99d",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "56f1d3c1-df61-4174-bfc6-aeb17945a621",
"Sequence": 1,
"AncestorCategoryId": "c661fa8b-2beb-4d00-89f9-f95ee9d58e8f",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "4ca2103a-f415-4c0b-9e83-b72a8ad64aaa",
"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": "4ca2103a-f415-4c0b-9e83-b72a8ad64aaa",
"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": "2c7a1cae-6a95-4ed2-8bd1-a0a7173d5188",
"CategoryId": "e3d94e92-77c5-431d-8426-7f7ae6d9d035",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "9272ab0a-9708-49fe-a9d6-b18712570aad",
"Score": 1.0,
"State": 1
},
{
"Id": "9272ab0a-9708-49fe-a9d6-b18712570aad",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "e8ba7781-fb24-4104-b8fe-32ede5b4f357",
"Questions": [
{
"Id": "42f68aec-5208-41e0-9c0e-415ef5179d1a",
"Answers": "sample string 2"
},
{
"Id": "42f68aec-5208-41e0-9c0e-415ef5179d1a",
"Answers": "sample string 2"
}
]
},
{
"Id": "e8ba7781-fb24-4104-b8fe-32ede5b4f357",
"Questions": [
{
"Id": "42f68aec-5208-41e0-9c0e-415ef5179d1a",
"Answers": "sample string 2"
},
{
"Id": "42f68aec-5208-41e0-9c0e-415ef5179d1a",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "a0b830b2-26d3-426d-a369-e2b81c2cef69",
"ContentItemId": "c64a3730-4e93-424a-9340-bc7439b15138",
"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-06T22:51:17.573368+00:00",
"RescheduleDate": "2026-08-06T22:51:17.573368+00:00"
},
{
"Id": "a0b830b2-26d3-426d-a369-e2b81c2cef69",
"ContentItemId": "c64a3730-4e93-424a-9340-bc7439b15138",
"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-06T22:51:17.573368+00:00",
"RescheduleDate": "2026-08-06T22:51:17.573368+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}
text/json
Sample:
{
"UserId": "712ae4e4-7a8d-47fa-b770-3c388e92b1db",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-08-06T22:51:17.6046126+00:00",
"Registration": {
"Id": "463762fb-f1c0-4acb-a4e6-c039ae308010",
"UserId": "08dcd0e2-5621-4163-a3db-ee62a5c6a6a6",
"IsCurrent": true,
"CenterId": "9fc60206-cb19-43aa-9de8-3d420947b8f1",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "efa6f4ac-6dbc-4098-a977-e02c9cf4f0c4",
"EndDate": "2026-08-06T22:51:17.573368+00:00",
"StartDate": "2026-08-06T22:51:17.573368+00:00",
"SchedulePreferenceDate": "2026-08-06T22:51:17.573368+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-06T22:51:17.573368+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "c63596a5-47fb-485b-9cfe-ea9301d7a99d",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "56f1d3c1-df61-4174-bfc6-aeb17945a621",
"Sequence": 1,
"AncestorCategoryId": "c661fa8b-2beb-4d00-89f9-f95ee9d58e8f",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "4ca2103a-f415-4c0b-9e83-b72a8ad64aaa",
"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": "4ca2103a-f415-4c0b-9e83-b72a8ad64aaa",
"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": "c63596a5-47fb-485b-9cfe-ea9301d7a99d",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "56f1d3c1-df61-4174-bfc6-aeb17945a621",
"Sequence": 1,
"AncestorCategoryId": "c661fa8b-2beb-4d00-89f9-f95ee9d58e8f",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "4ca2103a-f415-4c0b-9e83-b72a8ad64aaa",
"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": "4ca2103a-f415-4c0b-9e83-b72a8ad64aaa",
"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": "2c7a1cae-6a95-4ed2-8bd1-a0a7173d5188",
"CategoryId": "e3d94e92-77c5-431d-8426-7f7ae6d9d035",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "9272ab0a-9708-49fe-a9d6-b18712570aad",
"Score": 1.0,
"State": 1
},
{
"Id": "9272ab0a-9708-49fe-a9d6-b18712570aad",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "e8ba7781-fb24-4104-b8fe-32ede5b4f357",
"Questions": [
{
"Id": "42f68aec-5208-41e0-9c0e-415ef5179d1a",
"Answers": "sample string 2"
},
{
"Id": "42f68aec-5208-41e0-9c0e-415ef5179d1a",
"Answers": "sample string 2"
}
]
},
{
"Id": "e8ba7781-fb24-4104-b8fe-32ede5b4f357",
"Questions": [
{
"Id": "42f68aec-5208-41e0-9c0e-415ef5179d1a",
"Answers": "sample string 2"
},
{
"Id": "42f68aec-5208-41e0-9c0e-415ef5179d1a",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "a0b830b2-26d3-426d-a369-e2b81c2cef69",
"ContentItemId": "c64a3730-4e93-424a-9340-bc7439b15138",
"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-06T22:51:17.573368+00:00",
"RescheduleDate": "2026-08-06T22:51:17.573368+00:00"
},
{
"Id": "a0b830b2-26d3-426d-a369-e2b81c2cef69",
"ContentItemId": "c64a3730-4e93-424a-9340-bc7439b15138",
"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-06T22:51:17.573368+00:00",
"RescheduleDate": "2026-08-06T22:51:17.573368+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}