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": "571c31ca-0eba-4b90-9e25-5d384bd52671", "IsNewUser": true, "UserName": "sample string 3", "PrivacyPolicyApprove": true, "ServerTime": "2024-10-05T09:26:16.2779392+00:00", "Registration": { "Id": "7986b524-f8c6-411a-b565-fd26dd0e4b7a", "UserId": "22baa3ef-5ea6-4778-811e-0f65f6d2675a", "IsCurrent": true, "CenterId": "03162e26-a2da-4c6f-9876-0cd46d339e4c", "CenterZone": 5, "ContractId": "sample string 6", "CurrentContentItemId": "bf7e9bd5-61ff-4592-962a-1d45300f6c8c", "EndDate": "2024-10-05T09:26:16.2423021+00:00", "StartDate": "2024-10-05T09:26:16.2423021+00:00", "SchedulePreferenceDate": "2024-10-05T09:26:16.2423021+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:26:16.2423021+00:00" }, "Bookmarks": { "sample string 1": { "Id": "f7c6b828-f5a2-443d-b153-875e8671adb5", "Description": "sample string 2", "Duration": 1, "IsSkippable": true, "Url": "sample string 3", "CourseId": "6c6e47fb-4fb2-422a-a63a-8cc3cda69d65", "Sequence": 1, "AncestorCategoryId": "0c028d68-2a9e-4ec6-8e8b-e1e5a434698f", "TypeId": 5, "TypeName": "sample string 6", "Hierarchy": [ { "Id": "636d1077-c07e-4c51-92ce-5d17a11249c7", "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": "636d1077-c07e-4c51-92ce-5d17a11249c7", "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": "f7c6b828-f5a2-443d-b153-875e8671adb5", "Description": "sample string 2", "Duration": 1, "IsSkippable": true, "Url": "sample string 3", "CourseId": "6c6e47fb-4fb2-422a-a63a-8cc3cda69d65", "Sequence": 1, "AncestorCategoryId": "0c028d68-2a9e-4ec6-8e8b-e1e5a434698f", "TypeId": 5, "TypeName": "sample string 6", "Hierarchy": [ { "Id": "636d1077-c07e-4c51-92ce-5d17a11249c7", "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": "636d1077-c07e-4c51-92ce-5d17a11249c7", "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": "28d2de37-81c8-4d7b-904e-31fd5c99a1df", "CategoryId": "9a474513-0f35-45d2-9f17-1cc032e708c1", "DisclaimerConfirmed": true }, "Lessons": [ { "Id": "8fbfc8a8-a666-4bd9-8ecd-bb61e87d6013", "Score": 1.0, "State": 1 }, { "Id": "8fbfc8a8-a666-4bd9-8ecd-bb61e87d6013", "Score": 1.0, "State": 1 } ], "Surveys": [ { "Id": "0777c44c-1aac-4fb4-afdd-788abf0af670", "Questions": [ { "Id": "f8ceff9d-98fb-424e-b9bc-8d6b3c4d58bf", "Answers": "sample string 2" }, { "Id": "f8ceff9d-98fb-424e-b9bc-8d6b3c4d58bf", "Answers": "sample string 2" } ] }, { "Id": "0777c44c-1aac-4fb4-afdd-788abf0af670", "Questions": [ { "Id": "f8ceff9d-98fb-424e-b9bc-8d6b3c4d58bf", "Answers": "sample string 2" }, { "Id": "f8ceff9d-98fb-424e-b9bc-8d6b3c4d58bf", "Answers": "sample string 2" } ] } ], "Sessions": [ { "Id": "e483681a-acf5-497f-9bc8-c9b1a3d083f0", "ContentItemId": "12532b4b-aa9d-4b46-9c7c-01ae357bdcfb", "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:26:16.2423021+00:00", "RescheduleDate": "2024-10-05T09:26:16.2423021+00:00" }, { "Id": "e483681a-acf5-497f-9bc8-c9b1a3d083f0", "ContentItemId": "12532b4b-aa9d-4b46-9c7c-01ae357bdcfb", "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:26:16.2423021+00:00", "RescheduleDate": "2024-10-05T09:26:16.2423021+00:00" } ], "TotalRescheduleCount": 4, "StudentLevelInfo": { "StartLevel": "sample string 1", "EndLevel": "sample string 2", "CurrentLevel": "sample string 3" } }
text/json
Sample:
{ "UserId": "571c31ca-0eba-4b90-9e25-5d384bd52671", "IsNewUser": true, "UserName": "sample string 3", "PrivacyPolicyApprove": true, "ServerTime": "2024-10-05T09:26:16.3869046+00:00", "Registration": { "Id": "7986b524-f8c6-411a-b565-fd26dd0e4b7a", "UserId": "22baa3ef-5ea6-4778-811e-0f65f6d2675a", "IsCurrent": true, "CenterId": "03162e26-a2da-4c6f-9876-0cd46d339e4c", "CenterZone": 5, "ContractId": "sample string 6", "CurrentContentItemId": "bf7e9bd5-61ff-4592-962a-1d45300f6c8c", "EndDate": "2024-10-05T09:26:16.2423021+00:00", "StartDate": "2024-10-05T09:26:16.2423021+00:00", "SchedulePreferenceDate": "2024-10-05T09:26:16.2423021+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:26:16.2423021+00:00" }, "Bookmarks": { "sample string 1": { "Id": "f7c6b828-f5a2-443d-b153-875e8671adb5", "Description": "sample string 2", "Duration": 1, "IsSkippable": true, "Url": "sample string 3", "CourseId": "6c6e47fb-4fb2-422a-a63a-8cc3cda69d65", "Sequence": 1, "AncestorCategoryId": "0c028d68-2a9e-4ec6-8e8b-e1e5a434698f", "TypeId": 5, "TypeName": "sample string 6", "Hierarchy": [ { "Id": "636d1077-c07e-4c51-92ce-5d17a11249c7", "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": "636d1077-c07e-4c51-92ce-5d17a11249c7", "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": "f7c6b828-f5a2-443d-b153-875e8671adb5", "Description": "sample string 2", "Duration": 1, "IsSkippable": true, "Url": "sample string 3", "CourseId": "6c6e47fb-4fb2-422a-a63a-8cc3cda69d65", "Sequence": 1, "AncestorCategoryId": "0c028d68-2a9e-4ec6-8e8b-e1e5a434698f", "TypeId": 5, "TypeName": "sample string 6", "Hierarchy": [ { "Id": "636d1077-c07e-4c51-92ce-5d17a11249c7", "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": "636d1077-c07e-4c51-92ce-5d17a11249c7", "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": "28d2de37-81c8-4d7b-904e-31fd5c99a1df", "CategoryId": "9a474513-0f35-45d2-9f17-1cc032e708c1", "DisclaimerConfirmed": true }, "Lessons": [ { "Id": "8fbfc8a8-a666-4bd9-8ecd-bb61e87d6013", "Score": 1.0, "State": 1 }, { "Id": "8fbfc8a8-a666-4bd9-8ecd-bb61e87d6013", "Score": 1.0, "State": 1 } ], "Surveys": [ { "Id": "0777c44c-1aac-4fb4-afdd-788abf0af670", "Questions": [ { "Id": "f8ceff9d-98fb-424e-b9bc-8d6b3c4d58bf", "Answers": "sample string 2" }, { "Id": "f8ceff9d-98fb-424e-b9bc-8d6b3c4d58bf", "Answers": "sample string 2" } ] }, { "Id": "0777c44c-1aac-4fb4-afdd-788abf0af670", "Questions": [ { "Id": "f8ceff9d-98fb-424e-b9bc-8d6b3c4d58bf", "Answers": "sample string 2" }, { "Id": "f8ceff9d-98fb-424e-b9bc-8d6b3c4d58bf", "Answers": "sample string 2" } ] } ], "Sessions": [ { "Id": "e483681a-acf5-497f-9bc8-c9b1a3d083f0", "ContentItemId": "12532b4b-aa9d-4b46-9c7c-01ae357bdcfb", "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:26:16.2423021+00:00", "RescheduleDate": "2024-10-05T09:26:16.2423021+00:00" }, { "Id": "e483681a-acf5-497f-9bc8-c9b1a3d083f0", "ContentItemId": "12532b4b-aa9d-4b46-9c7c-01ae357bdcfb", "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:26:16.2423021+00:00", "RescheduleDate": "2024-10-05T09:26:16.2423021+00:00" } ], "TotalRescheduleCount": 4, "StudentLevelInfo": { "StartLevel": "sample string 1", "EndLevel": "sample string 2", "CurrentLevel": "sample string 3" } }