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": "651b05ce-da51-46fc-b100-59b3bb5440f1",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-06-30T15:19:16.0288713+00:00",
"Registration": {
"Id": "7e5d32c3-eac9-4f76-a199-bafa14109e15",
"UserId": "10250aa4-680b-4e33-b8e9-d3794117f896",
"IsCurrent": true,
"CenterId": "9eeb4833-cbdc-4049-a3b1-54f15514db17",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "7e0f4c5c-829e-44ed-9161-dc0638f32446",
"EndDate": "2026-06-30T15:19:16.0132415+00:00",
"StartDate": "2026-06-30T15:19:16.0132415+00:00",
"SchedulePreferenceDate": "2026-06-30T15:19:16.0132415+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-06-30T15:19:16.0132415+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "36d5cde6-5218-43bd-ac7a-7b4583d5a4ab",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "c7182e65-a223-4187-a3e0-78076cd7db66",
"Sequence": 1,
"AncestorCategoryId": "b0fcff4b-5c4d-4014-88aa-d42617c137a5",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "2ff8806e-d834-495c-a4fb-e711f2d5a98a",
"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": "2ff8806e-d834-495c-a4fb-e711f2d5a98a",
"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": "36d5cde6-5218-43bd-ac7a-7b4583d5a4ab",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "c7182e65-a223-4187-a3e0-78076cd7db66",
"Sequence": 1,
"AncestorCategoryId": "b0fcff4b-5c4d-4014-88aa-d42617c137a5",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "2ff8806e-d834-495c-a4fb-e711f2d5a98a",
"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": "2ff8806e-d834-495c-a4fb-e711f2d5a98a",
"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": "51f560b0-b7de-47ed-acd3-d7a81233a522",
"CategoryId": "5069349a-45ce-4db5-8694-9f09e3032366",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "3db3c997-7667-4682-b4d7-0980fa28f44e",
"Score": 1.0,
"State": 1
},
{
"Id": "3db3c997-7667-4682-b4d7-0980fa28f44e",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "01f6a332-865d-43ad-9022-57f93d9141ab",
"Questions": [
{
"Id": "ef0dbeb0-b0e5-4fa8-95a1-8982d7189220",
"Answers": "sample string 2"
},
{
"Id": "ef0dbeb0-b0e5-4fa8-95a1-8982d7189220",
"Answers": "sample string 2"
}
]
},
{
"Id": "01f6a332-865d-43ad-9022-57f93d9141ab",
"Questions": [
{
"Id": "ef0dbeb0-b0e5-4fa8-95a1-8982d7189220",
"Answers": "sample string 2"
},
{
"Id": "ef0dbeb0-b0e5-4fa8-95a1-8982d7189220",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "23223b02-dc7e-415e-90ac-4e798c6dfc4f",
"ContentItemId": "a9cc9a7b-a4d9-4031-ab0b-c82740e70db2",
"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-06-30T15:19:16.0132415+00:00",
"RescheduleDate": "2026-06-30T15:19:16.0132415+00:00"
},
{
"Id": "23223b02-dc7e-415e-90ac-4e798c6dfc4f",
"ContentItemId": "a9cc9a7b-a4d9-4031-ab0b-c82740e70db2",
"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-06-30T15:19:16.0132415+00:00",
"RescheduleDate": "2026-06-30T15:19:16.0132415+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}
text/json
Sample:
{
"UserId": "651b05ce-da51-46fc-b100-59b3bb5440f1",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-06-30T15:19:16.0601154+00:00",
"Registration": {
"Id": "7e5d32c3-eac9-4f76-a199-bafa14109e15",
"UserId": "10250aa4-680b-4e33-b8e9-d3794117f896",
"IsCurrent": true,
"CenterId": "9eeb4833-cbdc-4049-a3b1-54f15514db17",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "7e0f4c5c-829e-44ed-9161-dc0638f32446",
"EndDate": "2026-06-30T15:19:16.0132415+00:00",
"StartDate": "2026-06-30T15:19:16.0132415+00:00",
"SchedulePreferenceDate": "2026-06-30T15:19:16.0132415+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-06-30T15:19:16.0132415+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "36d5cde6-5218-43bd-ac7a-7b4583d5a4ab",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "c7182e65-a223-4187-a3e0-78076cd7db66",
"Sequence": 1,
"AncestorCategoryId": "b0fcff4b-5c4d-4014-88aa-d42617c137a5",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "2ff8806e-d834-495c-a4fb-e711f2d5a98a",
"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": "2ff8806e-d834-495c-a4fb-e711f2d5a98a",
"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": "36d5cde6-5218-43bd-ac7a-7b4583d5a4ab",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "c7182e65-a223-4187-a3e0-78076cd7db66",
"Sequence": 1,
"AncestorCategoryId": "b0fcff4b-5c4d-4014-88aa-d42617c137a5",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "2ff8806e-d834-495c-a4fb-e711f2d5a98a",
"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": "2ff8806e-d834-495c-a4fb-e711f2d5a98a",
"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": "51f560b0-b7de-47ed-acd3-d7a81233a522",
"CategoryId": "5069349a-45ce-4db5-8694-9f09e3032366",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "3db3c997-7667-4682-b4d7-0980fa28f44e",
"Score": 1.0,
"State": 1
},
{
"Id": "3db3c997-7667-4682-b4d7-0980fa28f44e",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "01f6a332-865d-43ad-9022-57f93d9141ab",
"Questions": [
{
"Id": "ef0dbeb0-b0e5-4fa8-95a1-8982d7189220",
"Answers": "sample string 2"
},
{
"Id": "ef0dbeb0-b0e5-4fa8-95a1-8982d7189220",
"Answers": "sample string 2"
}
]
},
{
"Id": "01f6a332-865d-43ad-9022-57f93d9141ab",
"Questions": [
{
"Id": "ef0dbeb0-b0e5-4fa8-95a1-8982d7189220",
"Answers": "sample string 2"
},
{
"Id": "ef0dbeb0-b0e5-4fa8-95a1-8982d7189220",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "23223b02-dc7e-415e-90ac-4e798c6dfc4f",
"ContentItemId": "a9cc9a7b-a4d9-4031-ab0b-c82740e70db2",
"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-06-30T15:19:16.0132415+00:00",
"RescheduleDate": "2026-06-30T15:19:16.0132415+00:00"
},
{
"Id": "23223b02-dc7e-415e-90ac-4e798c6dfc4f",
"ContentItemId": "a9cc9a7b-a4d9-4031-ab0b-c82740e70db2",
"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-06-30T15:19:16.0132415+00:00",
"RescheduleDate": "2026-06-30T15:19:16.0132415+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}