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": "0bb152dc-9b0a-46ce-a55c-16f0df33ee55",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-09-23T07:53:33.5633409+00:00",
"Registration": {
"Id": "f36052d7-e805-4b56-8238-e70cfc79577d",
"UserId": "5a9e60af-366c-4b4a-a481-43b488690938",
"IsCurrent": true,
"CenterId": "dbf6c80e-e8b5-4fc9-94ae-56bcfcf756d8",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "fccfdbf6-77d6-46b3-8e25-6cb8be0a3ab0",
"EndDate": "2026-09-23T07:53:33.5633409+00:00",
"StartDate": "2026-09-23T07:53:33.5633409+00:00",
"SchedulePreferenceDate": "2026-09-23T07:53:33.5633409+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-09-23T07:53:33.5633409+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "0e77468a-4c05-46cf-8f1a-3164939eb59b",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "a41684b4-a958-472a-9c71-d558a7402f13",
"Sequence": 1,
"AncestorCategoryId": "121b8f0d-fe54-4f46-88d0-8d130372d0f6",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "a21a34eb-0662-45ca-8847-1fc6e19f32ed",
"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": "a21a34eb-0662-45ca-8847-1fc6e19f32ed",
"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": "0e77468a-4c05-46cf-8f1a-3164939eb59b",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "a41684b4-a958-472a-9c71-d558a7402f13",
"Sequence": 1,
"AncestorCategoryId": "121b8f0d-fe54-4f46-88d0-8d130372d0f6",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "a21a34eb-0662-45ca-8847-1fc6e19f32ed",
"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": "a21a34eb-0662-45ca-8847-1fc6e19f32ed",
"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": "b916c02d-b995-4986-8e42-3ef7be618aea",
"CategoryId": "17b04b04-220e-4dfe-b9c4-b277876313f5",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "2df093d8-b0d4-4c2a-965e-b4c535b214da",
"Score": 1.0,
"State": 1
},
{
"Id": "2df093d8-b0d4-4c2a-965e-b4c535b214da",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "87fe258b-ff2e-4ce7-b140-72d0ef33bd65",
"Questions": [
{
"Id": "4eb25005-ff1e-4c7c-add6-dbfef78d3cc3",
"Answers": "sample string 2"
},
{
"Id": "4eb25005-ff1e-4c7c-add6-dbfef78d3cc3",
"Answers": "sample string 2"
}
]
},
{
"Id": "87fe258b-ff2e-4ce7-b140-72d0ef33bd65",
"Questions": [
{
"Id": "4eb25005-ff1e-4c7c-add6-dbfef78d3cc3",
"Answers": "sample string 2"
},
{
"Id": "4eb25005-ff1e-4c7c-add6-dbfef78d3cc3",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "2bedbbc7-1760-45c1-9225-1e005f711ca7",
"ContentItemId": "89f82dd2-ffaf-454b-a5db-a7dfa1384ca7",
"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-09-23T07:53:33.5633409+00:00",
"RescheduleDate": "2026-09-23T07:53:33.5633409+00:00"
},
{
"Id": "2bedbbc7-1760-45c1-9225-1e005f711ca7",
"ContentItemId": "89f82dd2-ffaf-454b-a5db-a7dfa1384ca7",
"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-09-23T07:53:33.5633409+00:00",
"RescheduleDate": "2026-09-23T07:53:33.5633409+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}
text/json
Sample:
{
"UserId": "0bb152dc-9b0a-46ce-a55c-16f0df33ee55",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-09-23T07:53:33.5945949+00:00",
"Registration": {
"Id": "f36052d7-e805-4b56-8238-e70cfc79577d",
"UserId": "5a9e60af-366c-4b4a-a481-43b488690938",
"IsCurrent": true,
"CenterId": "dbf6c80e-e8b5-4fc9-94ae-56bcfcf756d8",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "fccfdbf6-77d6-46b3-8e25-6cb8be0a3ab0",
"EndDate": "2026-09-23T07:53:33.5633409+00:00",
"StartDate": "2026-09-23T07:53:33.5633409+00:00",
"SchedulePreferenceDate": "2026-09-23T07:53:33.5633409+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-09-23T07:53:33.5633409+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "0e77468a-4c05-46cf-8f1a-3164939eb59b",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "a41684b4-a958-472a-9c71-d558a7402f13",
"Sequence": 1,
"AncestorCategoryId": "121b8f0d-fe54-4f46-88d0-8d130372d0f6",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "a21a34eb-0662-45ca-8847-1fc6e19f32ed",
"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": "a21a34eb-0662-45ca-8847-1fc6e19f32ed",
"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": "0e77468a-4c05-46cf-8f1a-3164939eb59b",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "a41684b4-a958-472a-9c71-d558a7402f13",
"Sequence": 1,
"AncestorCategoryId": "121b8f0d-fe54-4f46-88d0-8d130372d0f6",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "a21a34eb-0662-45ca-8847-1fc6e19f32ed",
"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": "a21a34eb-0662-45ca-8847-1fc6e19f32ed",
"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": "b916c02d-b995-4986-8e42-3ef7be618aea",
"CategoryId": "17b04b04-220e-4dfe-b9c4-b277876313f5",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "2df093d8-b0d4-4c2a-965e-b4c535b214da",
"Score": 1.0,
"State": 1
},
{
"Id": "2df093d8-b0d4-4c2a-965e-b4c535b214da",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "87fe258b-ff2e-4ce7-b140-72d0ef33bd65",
"Questions": [
{
"Id": "4eb25005-ff1e-4c7c-add6-dbfef78d3cc3",
"Answers": "sample string 2"
},
{
"Id": "4eb25005-ff1e-4c7c-add6-dbfef78d3cc3",
"Answers": "sample string 2"
}
]
},
{
"Id": "87fe258b-ff2e-4ce7-b140-72d0ef33bd65",
"Questions": [
{
"Id": "4eb25005-ff1e-4c7c-add6-dbfef78d3cc3",
"Answers": "sample string 2"
},
{
"Id": "4eb25005-ff1e-4c7c-add6-dbfef78d3cc3",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "2bedbbc7-1760-45c1-9225-1e005f711ca7",
"ContentItemId": "89f82dd2-ffaf-454b-a5db-a7dfa1384ca7",
"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-09-23T07:53:33.5633409+00:00",
"RescheduleDate": "2026-09-23T07:53:33.5633409+00:00"
},
{
"Id": "2bedbbc7-1760-45c1-9225-1e005f711ca7",
"ContentItemId": "89f82dd2-ffaf-454b-a5db-a7dfa1384ca7",
"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-09-23T07:53:33.5633409+00:00",
"RescheduleDate": "2026-09-23T07:53:33.5633409+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}