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": "08a0d2d9-479f-4881-80a9-ab36546dca23",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-02-12T22:53:37.0766505+00:00",
"Registration": {
"Id": "9b9b7ea7-1a2e-47ef-963a-1fe8ad96c0c5",
"UserId": "54425b88-5656-4b14-9671-086209c2ef48",
"IsCurrent": true,
"CenterId": "16dfeb2d-47af-4a4a-8694-fc3f763d7196",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "b31851ae-fd6f-4c6c-88f6-7cf83cf64f0f",
"EndDate": "2026-02-12T22:53:37.061026+00:00",
"StartDate": "2026-02-12T22:53:37.061026+00:00",
"SchedulePreferenceDate": "2026-02-12T22:53:37.061026+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-02-12T22:53:37.061026+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "7f0b91c1-1412-4dd7-a5e2-d987bd9078cc",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "b0b914ce-4a60-46ae-afd4-0c929be52182",
"Sequence": 1,
"AncestorCategoryId": "e69b1254-16e8-4ca2-aa53-17391375756f",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "6c7c63bd-92d5-49b0-9570-9b78f5a8b259",
"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": "6c7c63bd-92d5-49b0-9570-9b78f5a8b259",
"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": "7f0b91c1-1412-4dd7-a5e2-d987bd9078cc",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "b0b914ce-4a60-46ae-afd4-0c929be52182",
"Sequence": 1,
"AncestorCategoryId": "e69b1254-16e8-4ca2-aa53-17391375756f",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "6c7c63bd-92d5-49b0-9570-9b78f5a8b259",
"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": "6c7c63bd-92d5-49b0-9570-9b78f5a8b259",
"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": "fb1517fe-5b1d-40d3-8e8b-cafc97ad6124",
"CategoryId": "6339a6fd-9401-450f-86f4-be0de536da1f",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "febe1dd1-c09d-4f08-9793-389f9ed0ac37",
"Score": 1.0,
"State": 1
},
{
"Id": "febe1dd1-c09d-4f08-9793-389f9ed0ac37",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "20df4349-c913-421c-9ad5-97a1b55cb03c",
"Questions": [
{
"Id": "be95594f-71eb-4a30-aefb-f5b801b3c70a",
"Answers": "sample string 2"
},
{
"Id": "be95594f-71eb-4a30-aefb-f5b801b3c70a",
"Answers": "sample string 2"
}
]
},
{
"Id": "20df4349-c913-421c-9ad5-97a1b55cb03c",
"Questions": [
{
"Id": "be95594f-71eb-4a30-aefb-f5b801b3c70a",
"Answers": "sample string 2"
},
{
"Id": "be95594f-71eb-4a30-aefb-f5b801b3c70a",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "e429f5a6-47dd-4c54-9178-6a953f9ff04a",
"ContentItemId": "42db3d61-e28c-4e81-a1f2-5252de6995fa",
"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-02-12T22:53:37.0766505+00:00",
"RescheduleDate": "2026-02-12T22:53:37.0766505+00:00"
},
{
"Id": "e429f5a6-47dd-4c54-9178-6a953f9ff04a",
"ContentItemId": "42db3d61-e28c-4e81-a1f2-5252de6995fa",
"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-02-12T22:53:37.0766505+00:00",
"RescheduleDate": "2026-02-12T22:53:37.0766505+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}
text/json
Sample:
{
"UserId": "08a0d2d9-479f-4881-80a9-ab36546dca23",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-02-12T22:53:37.123522+00:00",
"Registration": {
"Id": "9b9b7ea7-1a2e-47ef-963a-1fe8ad96c0c5",
"UserId": "54425b88-5656-4b14-9671-086209c2ef48",
"IsCurrent": true,
"CenterId": "16dfeb2d-47af-4a4a-8694-fc3f763d7196",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "b31851ae-fd6f-4c6c-88f6-7cf83cf64f0f",
"EndDate": "2026-02-12T22:53:37.061026+00:00",
"StartDate": "2026-02-12T22:53:37.061026+00:00",
"SchedulePreferenceDate": "2026-02-12T22:53:37.061026+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-02-12T22:53:37.061026+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "7f0b91c1-1412-4dd7-a5e2-d987bd9078cc",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "b0b914ce-4a60-46ae-afd4-0c929be52182",
"Sequence": 1,
"AncestorCategoryId": "e69b1254-16e8-4ca2-aa53-17391375756f",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "6c7c63bd-92d5-49b0-9570-9b78f5a8b259",
"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": "6c7c63bd-92d5-49b0-9570-9b78f5a8b259",
"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": "7f0b91c1-1412-4dd7-a5e2-d987bd9078cc",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "b0b914ce-4a60-46ae-afd4-0c929be52182",
"Sequence": 1,
"AncestorCategoryId": "e69b1254-16e8-4ca2-aa53-17391375756f",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "6c7c63bd-92d5-49b0-9570-9b78f5a8b259",
"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": "6c7c63bd-92d5-49b0-9570-9b78f5a8b259",
"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": "fb1517fe-5b1d-40d3-8e8b-cafc97ad6124",
"CategoryId": "6339a6fd-9401-450f-86f4-be0de536da1f",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "febe1dd1-c09d-4f08-9793-389f9ed0ac37",
"Score": 1.0,
"State": 1
},
{
"Id": "febe1dd1-c09d-4f08-9793-389f9ed0ac37",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "20df4349-c913-421c-9ad5-97a1b55cb03c",
"Questions": [
{
"Id": "be95594f-71eb-4a30-aefb-f5b801b3c70a",
"Answers": "sample string 2"
},
{
"Id": "be95594f-71eb-4a30-aefb-f5b801b3c70a",
"Answers": "sample string 2"
}
]
},
{
"Id": "20df4349-c913-421c-9ad5-97a1b55cb03c",
"Questions": [
{
"Id": "be95594f-71eb-4a30-aefb-f5b801b3c70a",
"Answers": "sample string 2"
},
{
"Id": "be95594f-71eb-4a30-aefb-f5b801b3c70a",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "e429f5a6-47dd-4c54-9178-6a953f9ff04a",
"ContentItemId": "42db3d61-e28c-4e81-a1f2-5252de6995fa",
"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-02-12T22:53:37.0766505+00:00",
"RescheduleDate": "2026-02-12T22:53:37.0766505+00:00"
},
{
"Id": "e429f5a6-47dd-4c54-9178-6a953f9ff04a",
"ContentItemId": "42db3d61-e28c-4e81-a1f2-5252de6995fa",
"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-02-12T22:53:37.0766505+00:00",
"RescheduleDate": "2026-02-12T22:53:37.0766505+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}