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.UserStateBackwardCompatibleViewModelName | 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": "e04a9ff9-61a8-46b1-8719-1f138e343436", "IsNewUser": true, "UserName": "sample string 3", "PrivacyPolicyApprove": true, "ServerTime": "2025-07-01T06:18:12.7441818+00:00", "Registration": { "Id": "d015aeb1-0eac-414f-943e-45308ab598f3", "UserId": "0012aa21-fd32-4444-bdb5-e8265fe8d62b", "IsCurrent": true, "CenterId": "6f271b2f-e025-4930-94d1-72d211cbf352", "CenterZone": 5, "ContractId": "sample string 6", "CurrentContentItemId": "0544807b-7b62-4bc9-b95e-8c25e99b9f05", "EndDate": "2025-07-01T06:18:12.7285583+00:00", "StartDate": "2025-07-01T06:18:12.7285583+00:00", "SchedulePreferenceDate": "2025-07-01T06:18:12.7285583+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": "2025-07-01T06:18:12.7441818+00:00" }, "Bookmarks": { "sample string 1": { "Id": "bfcb84d9-d3ee-43ec-b012-a9062c7ace1e", "Description": "sample string 2", "Duration": 1, "IsSkippable": true, "Url": "sample string 3", "CourseId": "4da19321-6e7d-4fc0-96ee-370fb8f710bb", "Sequence": 1, "AncestorCategoryId": "09be7764-80c9-43d7-b6bc-9e9b96ba1a0f", "TypeId": 5, "TypeName": "sample string 6", "Hierarchy": [ { "Id": "f29c033a-d72c-4d72-92d4-a1d48101140f", "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": "f29c033a-d72c-4d72-92d4-a1d48101140f", "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": "bfcb84d9-d3ee-43ec-b012-a9062c7ace1e", "Description": "sample string 2", "Duration": 1, "IsSkippable": true, "Url": "sample string 3", "CourseId": "4da19321-6e7d-4fc0-96ee-370fb8f710bb", "Sequence": 1, "AncestorCategoryId": "09be7764-80c9-43d7-b6bc-9e9b96ba1a0f", "TypeId": 5, "TypeName": "sample string 6", "Hierarchy": [ { "Id": "f29c033a-d72c-4d72-92d4-a1d48101140f", "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": "f29c033a-d72c-4d72-92d4-a1d48101140f", "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": "3e06294c-2077-4d6d-b949-a091174aeba2", "CategoryId": "52bdc87c-2364-4cd3-a3a1-b896f62233d6", "DisclaimerConfirmed": true }, "Lessons": [ { "Id": "49a0ddeb-ad38-460a-a435-ac57dc0a0c76", "Score": 1.0, "State": 1 }, { "Id": "49a0ddeb-ad38-460a-a435-ac57dc0a0c76", "Score": 1.0, "State": 1 } ], "Surveys": [ { "Id": "960ff6db-c2e5-452f-89a7-7a3d84308995", "Questions": [ { "Id": "410fe29f-6f92-4aa8-bb7f-eb7efdf84a7d", "Answers": "sample string 2" }, { "Id": "410fe29f-6f92-4aa8-bb7f-eb7efdf84a7d", "Answers": "sample string 2" } ] }, { "Id": "960ff6db-c2e5-452f-89a7-7a3d84308995", "Questions": [ { "Id": "410fe29f-6f92-4aa8-bb7f-eb7efdf84a7d", "Answers": "sample string 2" }, { "Id": "410fe29f-6f92-4aa8-bb7f-eb7efdf84a7d", "Answers": "sample string 2" } ] } ], "Sessions": [ { "Id": "31610d7f-eeb5-4b0d-9bd8-bcee54db91aa", "ContentItemId": "47d12d38-0ecb-4f19-827c-588d35bc3f91", "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": "2025-07-01T06:18:12.7441818+00:00", "RescheduleDate": "2025-07-01T06:18:12.7441818+00:00" }, { "Id": "31610d7f-eeb5-4b0d-9bd8-bcee54db91aa", "ContentItemId": "47d12d38-0ecb-4f19-827c-588d35bc3f91", "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": "2025-07-01T06:18:12.7441818+00:00", "RescheduleDate": "2025-07-01T06:18:12.7441818+00:00" } ], "TotalRescheduleCount": 4, "StudentLevelInfo": { "StartLevel": "sample string 1", "EndLevel": "sample string 2", "CurrentLevel": "sample string 3" } }
text/json
Sample:
{ "UserId": "e04a9ff9-61a8-46b1-8719-1f138e343436", "IsNewUser": true, "UserName": "sample string 3", "PrivacyPolicyApprove": true, "ServerTime": "2025-07-01T06:18:12.7754281+00:00", "Registration": { "Id": "d015aeb1-0eac-414f-943e-45308ab598f3", "UserId": "0012aa21-fd32-4444-bdb5-e8265fe8d62b", "IsCurrent": true, "CenterId": "6f271b2f-e025-4930-94d1-72d211cbf352", "CenterZone": 5, "ContractId": "sample string 6", "CurrentContentItemId": "0544807b-7b62-4bc9-b95e-8c25e99b9f05", "EndDate": "2025-07-01T06:18:12.7285583+00:00", "StartDate": "2025-07-01T06:18:12.7285583+00:00", "SchedulePreferenceDate": "2025-07-01T06:18:12.7285583+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": "2025-07-01T06:18:12.7441818+00:00" }, "Bookmarks": { "sample string 1": { "Id": "bfcb84d9-d3ee-43ec-b012-a9062c7ace1e", "Description": "sample string 2", "Duration": 1, "IsSkippable": true, "Url": "sample string 3", "CourseId": "4da19321-6e7d-4fc0-96ee-370fb8f710bb", "Sequence": 1, "AncestorCategoryId": "09be7764-80c9-43d7-b6bc-9e9b96ba1a0f", "TypeId": 5, "TypeName": "sample string 6", "Hierarchy": [ { "Id": "f29c033a-d72c-4d72-92d4-a1d48101140f", "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": "f29c033a-d72c-4d72-92d4-a1d48101140f", "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": "bfcb84d9-d3ee-43ec-b012-a9062c7ace1e", "Description": "sample string 2", "Duration": 1, "IsSkippable": true, "Url": "sample string 3", "CourseId": "4da19321-6e7d-4fc0-96ee-370fb8f710bb", "Sequence": 1, "AncestorCategoryId": "09be7764-80c9-43d7-b6bc-9e9b96ba1a0f", "TypeId": 5, "TypeName": "sample string 6", "Hierarchy": [ { "Id": "f29c033a-d72c-4d72-92d4-a1d48101140f", "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": "f29c033a-d72c-4d72-92d4-a1d48101140f", "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": "3e06294c-2077-4d6d-b949-a091174aeba2", "CategoryId": "52bdc87c-2364-4cd3-a3a1-b896f62233d6", "DisclaimerConfirmed": true }, "Lessons": [ { "Id": "49a0ddeb-ad38-460a-a435-ac57dc0a0c76", "Score": 1.0, "State": 1 }, { "Id": "49a0ddeb-ad38-460a-a435-ac57dc0a0c76", "Score": 1.0, "State": 1 } ], "Surveys": [ { "Id": "960ff6db-c2e5-452f-89a7-7a3d84308995", "Questions": [ { "Id": "410fe29f-6f92-4aa8-bb7f-eb7efdf84a7d", "Answers": "sample string 2" }, { "Id": "410fe29f-6f92-4aa8-bb7f-eb7efdf84a7d", "Answers": "sample string 2" } ] }, { "Id": "960ff6db-c2e5-452f-89a7-7a3d84308995", "Questions": [ { "Id": "410fe29f-6f92-4aa8-bb7f-eb7efdf84a7d", "Answers": "sample string 2" }, { "Id": "410fe29f-6f92-4aa8-bb7f-eb7efdf84a7d", "Answers": "sample string 2" } ] } ], "Sessions": [ { "Id": "31610d7f-eeb5-4b0d-9bd8-bcee54db91aa", "ContentItemId": "47d12d38-0ecb-4f19-827c-588d35bc3f91", "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": "2025-07-01T06:18:12.7441818+00:00", "RescheduleDate": "2025-07-01T06:18:12.7441818+00:00" }, { "Id": "31610d7f-eeb5-4b0d-9bd8-bcee54db91aa", "ContentItemId": "47d12d38-0ecb-4f19-827c-588d35bc3f91", "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": "2025-07-01T06:18:12.7441818+00:00", "RescheduleDate": "2025-07-01T06:18:12.7441818+00:00" } ], "TotalRescheduleCount": 4, "StudentLevelInfo": { "StartLevel": "sample string 1", "EndLevel": "sample string 2", "CurrentLevel": "sample string 3" } }