GET v2/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.View.UserStateViewModelResponse Formats
application/json
Sample:
{ "UserId": "21e13e1a-9da9-424e-b06b-682d191c603a", "IsNewUser": true, "UserName": "sample string 3", "PrivacyPolicyApprove": true, "ServerTime": "2024-10-05T09:19:01.8347646+00:00", "Registration": [ { "Id": "cd9ba3d5-e895-4956-8b49-709c26a3e7cc", "UserId": "b80986ab-9bae-4c80-9aef-958bdc6dd9d0", "IsCurrent": true, "CenterId": "961d4b71-3a8e-4adf-9c1c-bb425ea738b5", "CenterZone": 5, "ContractId": "sample string 6", "CurrentContentItemId": "c16f6922-5cde-4d48-b21b-b0db859ae02d", "EndDate": "2024-10-05T09:19:01.787492+00:00", "StartDate": "2024-10-05T09:19:01.787492+00:00", "SchedulePreferenceDate": "2024-10-05T09:19:01.787492+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 }, { "Id": "cd9ba3d5-e895-4956-8b49-709c26a3e7cc", "UserId": "b80986ab-9bae-4c80-9aef-958bdc6dd9d0", "IsCurrent": true, "CenterId": "961d4b71-3a8e-4adf-9c1c-bb425ea738b5", "CenterZone": 5, "ContractId": "sample string 6", "CurrentContentItemId": "c16f6922-5cde-4d48-b21b-b0db859ae02d", "EndDate": "2024-10-05T09:19:01.787492+00:00", "StartDate": "2024-10-05T09:19:01.787492+00:00", "SchedulePreferenceDate": "2024-10-05T09:19:01.787492+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:19:01.80602+00:00" }, "Bookmarks": { "sample string 1": { "Id": "90d4f700-d721-4cc4-bffb-acaada10d102", "Description": "sample string 2", "Duration": 1, "IsSkippable": true, "Url": "sample string 3", "CourseId": "1bb99f62-62d0-4c35-a9ef-f923322c7f79", "Sequence": 1, "AncestorCategoryId": "545281fc-7ea5-44d8-9f51-889d4ec7d604", "TypeId": 5, "TypeName": "sample string 6", "Hierarchy": [ { "Id": "b973b959-3f30-4d01-a6d0-fd8f73b2922f", "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": "b973b959-3f30-4d01-a6d0-fd8f73b2922f", "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": "90d4f700-d721-4cc4-bffb-acaada10d102", "Description": "sample string 2", "Duration": 1, "IsSkippable": true, "Url": "sample string 3", "CourseId": "1bb99f62-62d0-4c35-a9ef-f923322c7f79", "Sequence": 1, "AncestorCategoryId": "545281fc-7ea5-44d8-9f51-889d4ec7d604", "TypeId": 5, "TypeName": "sample string 6", "Hierarchy": [ { "Id": "b973b959-3f30-4d01-a6d0-fd8f73b2922f", "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": "b973b959-3f30-4d01-a6d0-fd8f73b2922f", "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": "a5264548-8971-40d0-95b1-02e052a4c1e3", "CategoryId": "5360fe76-2cbc-48ec-ad04-5b16fd28104d", "DisclaimerConfirmed": true }, "Lessons": [ { "Id": "95230580-fc3c-40c1-9cf7-4aa45ee2b941", "Score": 1.0, "State": 1 }, { "Id": "95230580-fc3c-40c1-9cf7-4aa45ee2b941", "Score": 1.0, "State": 1 } ], "Surveys": [ { "Id": "f64601d7-ef00-4ee3-bf5c-21b22a132a7e", "Questions": [ { "Id": "cbec06a2-60c8-43b1-88ee-30d9746fb17d", "Answers": "sample string 2" }, { "Id": "cbec06a2-60c8-43b1-88ee-30d9746fb17d", "Answers": "sample string 2" } ] }, { "Id": "f64601d7-ef00-4ee3-bf5c-21b22a132a7e", "Questions": [ { "Id": "cbec06a2-60c8-43b1-88ee-30d9746fb17d", "Answers": "sample string 2" }, { "Id": "cbec06a2-60c8-43b1-88ee-30d9746fb17d", "Answers": "sample string 2" } ] } ], "Sessions": [ { "Id": "0ac24a3a-f158-4057-a692-590bdcd5b837", "ContentItemId": "4b7228cb-e5ac-4419-8c36-c67449eeb82c", "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:19:01.8187457+00:00", "RescheduleDate": "2024-10-05T09:19:01.8187457+00:00" }, { "Id": "0ac24a3a-f158-4057-a692-590bdcd5b837", "ContentItemId": "4b7228cb-e5ac-4419-8c36-c67449eeb82c", "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:19:01.8187457+00:00", "RescheduleDate": "2024-10-05T09:19:01.8187457+00:00" } ], "TotalRescheduleCount": 4, "StudentLevelInfo": { "StartLevel": "sample string 1", "EndLevel": "sample string 2", "CurrentLevel": "sample string 3" } }
text/json
Sample:
{ "UserId": "21e13e1a-9da9-424e-b06b-682d191c603a", "IsNewUser": true, "UserName": "sample string 3", "PrivacyPolicyApprove": true, "ServerTime": "2024-10-05T09:19:02.021874+00:00", "Registration": [ { "Id": "cd9ba3d5-e895-4956-8b49-709c26a3e7cc", "UserId": "b80986ab-9bae-4c80-9aef-958bdc6dd9d0", "IsCurrent": true, "CenterId": "961d4b71-3a8e-4adf-9c1c-bb425ea738b5", "CenterZone": 5, "ContractId": "sample string 6", "CurrentContentItemId": "c16f6922-5cde-4d48-b21b-b0db859ae02d", "EndDate": "2024-10-05T09:19:01.787492+00:00", "StartDate": "2024-10-05T09:19:01.787492+00:00", "SchedulePreferenceDate": "2024-10-05T09:19:01.787492+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 }, { "Id": "cd9ba3d5-e895-4956-8b49-709c26a3e7cc", "UserId": "b80986ab-9bae-4c80-9aef-958bdc6dd9d0", "IsCurrent": true, "CenterId": "961d4b71-3a8e-4adf-9c1c-bb425ea738b5", "CenterZone": 5, "ContractId": "sample string 6", "CurrentContentItemId": "c16f6922-5cde-4d48-b21b-b0db859ae02d", "EndDate": "2024-10-05T09:19:01.787492+00:00", "StartDate": "2024-10-05T09:19:01.787492+00:00", "SchedulePreferenceDate": "2024-10-05T09:19:01.787492+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:19:01.80602+00:00" }, "Bookmarks": { "sample string 1": { "Id": "90d4f700-d721-4cc4-bffb-acaada10d102", "Description": "sample string 2", "Duration": 1, "IsSkippable": true, "Url": "sample string 3", "CourseId": "1bb99f62-62d0-4c35-a9ef-f923322c7f79", "Sequence": 1, "AncestorCategoryId": "545281fc-7ea5-44d8-9f51-889d4ec7d604", "TypeId": 5, "TypeName": "sample string 6", "Hierarchy": [ { "Id": "b973b959-3f30-4d01-a6d0-fd8f73b2922f", "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": "b973b959-3f30-4d01-a6d0-fd8f73b2922f", "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": "90d4f700-d721-4cc4-bffb-acaada10d102", "Description": "sample string 2", "Duration": 1, "IsSkippable": true, "Url": "sample string 3", "CourseId": "1bb99f62-62d0-4c35-a9ef-f923322c7f79", "Sequence": 1, "AncestorCategoryId": "545281fc-7ea5-44d8-9f51-889d4ec7d604", "TypeId": 5, "TypeName": "sample string 6", "Hierarchy": [ { "Id": "b973b959-3f30-4d01-a6d0-fd8f73b2922f", "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": "b973b959-3f30-4d01-a6d0-fd8f73b2922f", "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": "a5264548-8971-40d0-95b1-02e052a4c1e3", "CategoryId": "5360fe76-2cbc-48ec-ad04-5b16fd28104d", "DisclaimerConfirmed": true }, "Lessons": [ { "Id": "95230580-fc3c-40c1-9cf7-4aa45ee2b941", "Score": 1.0, "State": 1 }, { "Id": "95230580-fc3c-40c1-9cf7-4aa45ee2b941", "Score": 1.0, "State": 1 } ], "Surveys": [ { "Id": "f64601d7-ef00-4ee3-bf5c-21b22a132a7e", "Questions": [ { "Id": "cbec06a2-60c8-43b1-88ee-30d9746fb17d", "Answers": "sample string 2" }, { "Id": "cbec06a2-60c8-43b1-88ee-30d9746fb17d", "Answers": "sample string 2" } ] }, { "Id": "f64601d7-ef00-4ee3-bf5c-21b22a132a7e", "Questions": [ { "Id": "cbec06a2-60c8-43b1-88ee-30d9746fb17d", "Answers": "sample string 2" }, { "Id": "cbec06a2-60c8-43b1-88ee-30d9746fb17d", "Answers": "sample string 2" } ] } ], "Sessions": [ { "Id": "0ac24a3a-f158-4057-a692-590bdcd5b837", "ContentItemId": "4b7228cb-e5ac-4419-8c36-c67449eeb82c", "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:19:01.8187457+00:00", "RescheduleDate": "2024-10-05T09:19:01.8187457+00:00" }, { "Id": "0ac24a3a-f158-4057-a692-590bdcd5b837", "ContentItemId": "4b7228cb-e5ac-4419-8c36-c67449eeb82c", "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:19:01.8187457+00:00", "RescheduleDate": "2024-10-05T09:19:01.8187457+00:00" } ], "TotalRescheduleCount": 4, "StudentLevelInfo": { "StartLevel": "sample string 1", "EndLevel": "sample string 2", "CurrentLevel": "sample string 3" } }