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": "36cf6601-b7b1-4d17-a27b-de888bf6e6c0", "IsNewUser": true, "UserName": "sample string 3", "PrivacyPolicyApprove": true, "ServerTime": "2024-10-05T09:16:37.9019073+00:00", "Registration": { "Id": "a4a1b78a-8eff-4678-b4cc-b4de20c9fd72", "UserId": "420fe03a-139b-4adf-80d9-f3f445ea2a87", "IsCurrent": true, "CenterId": "9d86cb2a-a71c-49a5-8240-e8876a96c7bb", "CenterZone": 5, "ContractId": "sample string 6", "CurrentContentItemId": "1bb6c4f6-a34e-45af-88c5-c5ddd6ea053e", "EndDate": "2024-10-05T09:16:37.8862876+00:00", "StartDate": "2024-10-05T09:16:37.8862876+00:00", "SchedulePreferenceDate": "2024-10-05T09:16:37.8862876+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 }, "TimeZone": { "Name": "sample string 1", "IanaName": "sample string 2", "LocalUtcOffset": "00:00:00.1234567", "LocalDateTime": "2024-10-05T09:16:37.8862876+00:00" }, "Bookmarks": { "sample string 1": { "Id": "f8b54224-21fb-4011-acb3-e36f3d7fdf14", "Description": "sample string 2", "Duration": 1, "IsSkippable": true, "Url": "sample string 3", "CourseId": "7fc0bc56-293c-4cd3-a51a-60c0c5844716", "Sequence": 1, "AncestorCategoryId": "91e33824-90bd-445e-a0e2-e21982491439", "TypeId": 5, "TypeName": "sample string 6", "Hierarchy": [ { "Id": "7ad10eed-03d5-42be-95c0-61593ee8b814", "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": "7ad10eed-03d5-42be-95c0-61593ee8b814", "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": "f8b54224-21fb-4011-acb3-e36f3d7fdf14", "Description": "sample string 2", "Duration": 1, "IsSkippable": true, "Url": "sample string 3", "CourseId": "7fc0bc56-293c-4cd3-a51a-60c0c5844716", "Sequence": 1, "AncestorCategoryId": "91e33824-90bd-445e-a0e2-e21982491439", "TypeId": 5, "TypeName": "sample string 6", "Hierarchy": [ { "Id": "7ad10eed-03d5-42be-95c0-61593ee8b814", "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": "7ad10eed-03d5-42be-95c0-61593ee8b814", "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": "d5fa6e5b-ec05-48c2-9f1e-70dfa57af40f", "CategoryId": "57f17b4e-ff13-4651-81bf-521126cf0521", "DisclaimerConfirmed": true }, "Lessons": [ { "Id": "863cf3c1-24e1-48df-96e9-ae9ef7a22d53", "Score": 1.0, "State": 1 }, { "Id": "863cf3c1-24e1-48df-96e9-ae9ef7a22d53", "Score": 1.0, "State": 1 } ], "Surveys": [ { "Id": "17b0d93e-d800-4e56-854e-eef4dd2f97b4", "Questions": [ { "Id": "caefbf06-a41b-4b47-b48d-ef88cac7f305", "Answers": "sample string 2" }, { "Id": "caefbf06-a41b-4b47-b48d-ef88cac7f305", "Answers": "sample string 2" } ] }, { "Id": "17b0d93e-d800-4e56-854e-eef4dd2f97b4", "Questions": [ { "Id": "caefbf06-a41b-4b47-b48d-ef88cac7f305", "Answers": "sample string 2" }, { "Id": "caefbf06-a41b-4b47-b48d-ef88cac7f305", "Answers": "sample string 2" } ] } ], "Sessions": [ { "Id": "588c001c-032e-481e-a7af-4772a2fdb841", "ContentItemId": "40c3244f-8694-4b8c-8125-3d684d90a553", "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": "2024-10-05T09:16:37.8862876+00:00", "RescheduleDate": "2024-10-05T09:16:37.9019073+00:00" }, { "Id": "588c001c-032e-481e-a7af-4772a2fdb841", "ContentItemId": "40c3244f-8694-4b8c-8125-3d684d90a553", "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": "2024-10-05T09:16:37.8862876+00:00", "RescheduleDate": "2024-10-05T09:16:37.9019073+00:00" } ], "TotalRescheduleCount": 4, "StudentLevelInfo": { "StartLevel": "sample string 1", "EndLevel": "sample string 2", "CurrentLevel": "sample string 3" } }
text/json
Sample:
{ "UserId": "36cf6601-b7b1-4d17-a27b-de888bf6e6c0", "IsNewUser": true, "UserName": "sample string 3", "PrivacyPolicyApprove": true, "ServerTime": "2024-10-05T09:16:37.9487857+00:00", "Registration": { "Id": "a4a1b78a-8eff-4678-b4cc-b4de20c9fd72", "UserId": "420fe03a-139b-4adf-80d9-f3f445ea2a87", "IsCurrent": true, "CenterId": "9d86cb2a-a71c-49a5-8240-e8876a96c7bb", "CenterZone": 5, "ContractId": "sample string 6", "CurrentContentItemId": "1bb6c4f6-a34e-45af-88c5-c5ddd6ea053e", "EndDate": "2024-10-05T09:16:37.8862876+00:00", "StartDate": "2024-10-05T09:16:37.8862876+00:00", "SchedulePreferenceDate": "2024-10-05T09:16:37.8862876+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 }, "TimeZone": { "Name": "sample string 1", "IanaName": "sample string 2", "LocalUtcOffset": "00:00:00.1234567", "LocalDateTime": "2024-10-05T09:16:37.8862876+00:00" }, "Bookmarks": { "sample string 1": { "Id": "f8b54224-21fb-4011-acb3-e36f3d7fdf14", "Description": "sample string 2", "Duration": 1, "IsSkippable": true, "Url": "sample string 3", "CourseId": "7fc0bc56-293c-4cd3-a51a-60c0c5844716", "Sequence": 1, "AncestorCategoryId": "91e33824-90bd-445e-a0e2-e21982491439", "TypeId": 5, "TypeName": "sample string 6", "Hierarchy": [ { "Id": "7ad10eed-03d5-42be-95c0-61593ee8b814", "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": "7ad10eed-03d5-42be-95c0-61593ee8b814", "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": "f8b54224-21fb-4011-acb3-e36f3d7fdf14", "Description": "sample string 2", "Duration": 1, "IsSkippable": true, "Url": "sample string 3", "CourseId": "7fc0bc56-293c-4cd3-a51a-60c0c5844716", "Sequence": 1, "AncestorCategoryId": "91e33824-90bd-445e-a0e2-e21982491439", "TypeId": 5, "TypeName": "sample string 6", "Hierarchy": [ { "Id": "7ad10eed-03d5-42be-95c0-61593ee8b814", "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": "7ad10eed-03d5-42be-95c0-61593ee8b814", "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": "d5fa6e5b-ec05-48c2-9f1e-70dfa57af40f", "CategoryId": "57f17b4e-ff13-4651-81bf-521126cf0521", "DisclaimerConfirmed": true }, "Lessons": [ { "Id": "863cf3c1-24e1-48df-96e9-ae9ef7a22d53", "Score": 1.0, "State": 1 }, { "Id": "863cf3c1-24e1-48df-96e9-ae9ef7a22d53", "Score": 1.0, "State": 1 } ], "Surveys": [ { "Id": "17b0d93e-d800-4e56-854e-eef4dd2f97b4", "Questions": [ { "Id": "caefbf06-a41b-4b47-b48d-ef88cac7f305", "Answers": "sample string 2" }, { "Id": "caefbf06-a41b-4b47-b48d-ef88cac7f305", "Answers": "sample string 2" } ] }, { "Id": "17b0d93e-d800-4e56-854e-eef4dd2f97b4", "Questions": [ { "Id": "caefbf06-a41b-4b47-b48d-ef88cac7f305", "Answers": "sample string 2" }, { "Id": "caefbf06-a41b-4b47-b48d-ef88cac7f305", "Answers": "sample string 2" } ] } ], "Sessions": [ { "Id": "588c001c-032e-481e-a7af-4772a2fdb841", "ContentItemId": "40c3244f-8694-4b8c-8125-3d684d90a553", "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": "2024-10-05T09:16:37.8862876+00:00", "RescheduleDate": "2024-10-05T09:16:37.9019073+00:00" }, { "Id": "588c001c-032e-481e-a7af-4772a2fdb841", "ContentItemId": "40c3244f-8694-4b8c-8125-3d684d90a553", "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": "2024-10-05T09:16:37.8862876+00:00", "RescheduleDate": "2024-10-05T09:16:37.9019073+00:00" } ], "TotalRescheduleCount": 4, "StudentLevelInfo": { "StartLevel": "sample string 1", "EndLevel": "sample string 2", "CurrentLevel": "sample string 3" } }