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": "a7f9bbaa-8657-4bd4-8999-2773d9b896ae",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-07-27T23:14:18.7932716+00:00",
"Registration": {
"Id": "4b41409e-b6d9-49b8-b532-cb447d713ee2",
"UserId": "8e05b44a-193b-41a3-aa12-394aa231c669",
"IsCurrent": true,
"CenterId": "28e94200-3de5-4a6e-a7c2-6d6df3b03059",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "d7a958b1-ae30-482b-b1ac-e52ff5c9d092",
"EndDate": "2026-07-27T23:14:18.7932716+00:00",
"StartDate": "2026-07-27T23:14:18.7932716+00:00",
"SchedulePreferenceDate": "2026-07-27T23:14:18.7932716+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-07-27T23:14:18.7932716+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "0e48130e-e6fc-40b8-9051-aae0907d58bc",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "f552c97c-9e33-4e7c-a25d-47b9413761d0",
"Sequence": 1,
"AncestorCategoryId": "3c6b54a9-b6da-4e6d-b6d4-5e52ae69c06b",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "895b725d-890f-4482-af7f-800d481d3d97",
"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": "895b725d-890f-4482-af7f-800d481d3d97",
"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": "0e48130e-e6fc-40b8-9051-aae0907d58bc",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "f552c97c-9e33-4e7c-a25d-47b9413761d0",
"Sequence": 1,
"AncestorCategoryId": "3c6b54a9-b6da-4e6d-b6d4-5e52ae69c06b",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "895b725d-890f-4482-af7f-800d481d3d97",
"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": "895b725d-890f-4482-af7f-800d481d3d97",
"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": "aca3671a-a495-4902-a808-ab45a059cef5",
"CategoryId": "bc70391a-0783-4fc1-8e58-e78a6404738f",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "c87ba453-d257-485f-a113-7f7dba8fe5d0",
"Score": 1.0,
"State": 1
},
{
"Id": "c87ba453-d257-485f-a113-7f7dba8fe5d0",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "2a198b2c-3101-4385-bce2-99baa1557128",
"Questions": [
{
"Id": "725b360d-21e2-46f7-9dd5-f4c652b6de7d",
"Answers": "sample string 2"
},
{
"Id": "725b360d-21e2-46f7-9dd5-f4c652b6de7d",
"Answers": "sample string 2"
}
]
},
{
"Id": "2a198b2c-3101-4385-bce2-99baa1557128",
"Questions": [
{
"Id": "725b360d-21e2-46f7-9dd5-f4c652b6de7d",
"Answers": "sample string 2"
},
{
"Id": "725b360d-21e2-46f7-9dd5-f4c652b6de7d",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "e52bae88-4fc7-411e-ae12-212da38142f3",
"ContentItemId": "0277c26d-c8ef-4ad6-a76c-11c2061ecbae",
"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-07-27T23:14:18.7932716+00:00",
"RescheduleDate": "2026-07-27T23:14:18.7932716+00:00"
},
{
"Id": "e52bae88-4fc7-411e-ae12-212da38142f3",
"ContentItemId": "0277c26d-c8ef-4ad6-a76c-11c2061ecbae",
"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-07-27T23:14:18.7932716+00:00",
"RescheduleDate": "2026-07-27T23:14:18.7932716+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}
text/json
Sample:
{
"UserId": "a7f9bbaa-8657-4bd4-8999-2773d9b896ae",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-07-27T23:14:18.8401461+00:00",
"Registration": {
"Id": "4b41409e-b6d9-49b8-b532-cb447d713ee2",
"UserId": "8e05b44a-193b-41a3-aa12-394aa231c669",
"IsCurrent": true,
"CenterId": "28e94200-3de5-4a6e-a7c2-6d6df3b03059",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "d7a958b1-ae30-482b-b1ac-e52ff5c9d092",
"EndDate": "2026-07-27T23:14:18.7932716+00:00",
"StartDate": "2026-07-27T23:14:18.7932716+00:00",
"SchedulePreferenceDate": "2026-07-27T23:14:18.7932716+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-07-27T23:14:18.7932716+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "0e48130e-e6fc-40b8-9051-aae0907d58bc",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "f552c97c-9e33-4e7c-a25d-47b9413761d0",
"Sequence": 1,
"AncestorCategoryId": "3c6b54a9-b6da-4e6d-b6d4-5e52ae69c06b",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "895b725d-890f-4482-af7f-800d481d3d97",
"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": "895b725d-890f-4482-af7f-800d481d3d97",
"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": "0e48130e-e6fc-40b8-9051-aae0907d58bc",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "f552c97c-9e33-4e7c-a25d-47b9413761d0",
"Sequence": 1,
"AncestorCategoryId": "3c6b54a9-b6da-4e6d-b6d4-5e52ae69c06b",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "895b725d-890f-4482-af7f-800d481d3d97",
"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": "895b725d-890f-4482-af7f-800d481d3d97",
"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": "aca3671a-a495-4902-a808-ab45a059cef5",
"CategoryId": "bc70391a-0783-4fc1-8e58-e78a6404738f",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "c87ba453-d257-485f-a113-7f7dba8fe5d0",
"Score": 1.0,
"State": 1
},
{
"Id": "c87ba453-d257-485f-a113-7f7dba8fe5d0",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "2a198b2c-3101-4385-bce2-99baa1557128",
"Questions": [
{
"Id": "725b360d-21e2-46f7-9dd5-f4c652b6de7d",
"Answers": "sample string 2"
},
{
"Id": "725b360d-21e2-46f7-9dd5-f4c652b6de7d",
"Answers": "sample string 2"
}
]
},
{
"Id": "2a198b2c-3101-4385-bce2-99baa1557128",
"Questions": [
{
"Id": "725b360d-21e2-46f7-9dd5-f4c652b6de7d",
"Answers": "sample string 2"
},
{
"Id": "725b360d-21e2-46f7-9dd5-f4c652b6de7d",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "e52bae88-4fc7-411e-ae12-212da38142f3",
"ContentItemId": "0277c26d-c8ef-4ad6-a76c-11c2061ecbae",
"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-07-27T23:14:18.7932716+00:00",
"RescheduleDate": "2026-07-27T23:14:18.7932716+00:00"
},
{
"Id": "e52bae88-4fc7-411e-ae12-212da38142f3",
"ContentItemId": "0277c26d-c8ef-4ad6-a76c-11c2061ecbae",
"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-07-27T23:14:18.7932716+00:00",
"RescheduleDate": "2026-07-27T23:14:18.7932716+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}