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": "de7cc848-1460-4d35-af7c-ea128d34236d",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-07-30T02:07:00.6967869+00:00",
"Registration": {
"Id": "cc47b51a-bda8-4ec8-8ac5-bc4c83658798",
"UserId": "d960c244-942b-466b-8bb9-df053b6536a9",
"IsCurrent": true,
"CenterId": "373c252f-d5bb-4c74-bdca-24f19ce033dc",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "44c69859-1833-4141-b0ea-55633feb20b9",
"EndDate": "2026-07-30T02:07:00.6655379+00:00",
"StartDate": "2026-07-30T02:07:00.6655379+00:00",
"SchedulePreferenceDate": "2026-07-30T02:07:00.6655379+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-30T02:07:00.6811631+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "b4a8218c-f730-47c4-b09c-75e34e3e34fe",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "62f58d3d-11b7-446b-a752-668d3bda507c",
"Sequence": 1,
"AncestorCategoryId": "9d79cad2-886e-410f-a8fe-379e7e63555d",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "565fde4e-e571-404c-bce7-a81eb79e2bb5",
"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": "565fde4e-e571-404c-bce7-a81eb79e2bb5",
"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": "b4a8218c-f730-47c4-b09c-75e34e3e34fe",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "62f58d3d-11b7-446b-a752-668d3bda507c",
"Sequence": 1,
"AncestorCategoryId": "9d79cad2-886e-410f-a8fe-379e7e63555d",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "565fde4e-e571-404c-bce7-a81eb79e2bb5",
"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": "565fde4e-e571-404c-bce7-a81eb79e2bb5",
"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": "2492a43f-2ae1-4c0f-a5fa-3c6fab309fd0",
"CategoryId": "87a660d9-2b28-4c80-9222-16e69625a7fb",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "57c0b1b3-154f-4020-991f-ea5403dbf920",
"Score": 1.0,
"State": 1
},
{
"Id": "57c0b1b3-154f-4020-991f-ea5403dbf920",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "18deed35-0fe1-4910-b84b-39fbff4dae2d",
"Questions": [
{
"Id": "58e73289-9bfc-4956-a7e2-4d63396d2be8",
"Answers": "sample string 2"
},
{
"Id": "58e73289-9bfc-4956-a7e2-4d63396d2be8",
"Answers": "sample string 2"
}
]
},
{
"Id": "18deed35-0fe1-4910-b84b-39fbff4dae2d",
"Questions": [
{
"Id": "58e73289-9bfc-4956-a7e2-4d63396d2be8",
"Answers": "sample string 2"
},
{
"Id": "58e73289-9bfc-4956-a7e2-4d63396d2be8",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "d544dac6-d6d2-4cfb-a62a-c7ad4a150641",
"ContentItemId": "a896c953-7afa-4d94-84c8-b797258b4ecb",
"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-30T02:07:00.6811631+00:00",
"RescheduleDate": "2026-07-30T02:07:00.6811631+00:00"
},
{
"Id": "d544dac6-d6d2-4cfb-a62a-c7ad4a150641",
"ContentItemId": "a896c953-7afa-4d94-84c8-b797258b4ecb",
"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-30T02:07:00.6811631+00:00",
"RescheduleDate": "2026-07-30T02:07:00.6811631+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}
text/json
Sample:
{
"UserId": "de7cc848-1460-4d35-af7c-ea128d34236d",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-07-30T02:07:00.7749127+00:00",
"Registration": {
"Id": "cc47b51a-bda8-4ec8-8ac5-bc4c83658798",
"UserId": "d960c244-942b-466b-8bb9-df053b6536a9",
"IsCurrent": true,
"CenterId": "373c252f-d5bb-4c74-bdca-24f19ce033dc",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "44c69859-1833-4141-b0ea-55633feb20b9",
"EndDate": "2026-07-30T02:07:00.6655379+00:00",
"StartDate": "2026-07-30T02:07:00.6655379+00:00",
"SchedulePreferenceDate": "2026-07-30T02:07:00.6655379+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-30T02:07:00.6811631+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "b4a8218c-f730-47c4-b09c-75e34e3e34fe",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "62f58d3d-11b7-446b-a752-668d3bda507c",
"Sequence": 1,
"AncestorCategoryId": "9d79cad2-886e-410f-a8fe-379e7e63555d",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "565fde4e-e571-404c-bce7-a81eb79e2bb5",
"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": "565fde4e-e571-404c-bce7-a81eb79e2bb5",
"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": "b4a8218c-f730-47c4-b09c-75e34e3e34fe",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "62f58d3d-11b7-446b-a752-668d3bda507c",
"Sequence": 1,
"AncestorCategoryId": "9d79cad2-886e-410f-a8fe-379e7e63555d",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "565fde4e-e571-404c-bce7-a81eb79e2bb5",
"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": "565fde4e-e571-404c-bce7-a81eb79e2bb5",
"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": "2492a43f-2ae1-4c0f-a5fa-3c6fab309fd0",
"CategoryId": "87a660d9-2b28-4c80-9222-16e69625a7fb",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "57c0b1b3-154f-4020-991f-ea5403dbf920",
"Score": 1.0,
"State": 1
},
{
"Id": "57c0b1b3-154f-4020-991f-ea5403dbf920",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "18deed35-0fe1-4910-b84b-39fbff4dae2d",
"Questions": [
{
"Id": "58e73289-9bfc-4956-a7e2-4d63396d2be8",
"Answers": "sample string 2"
},
{
"Id": "58e73289-9bfc-4956-a7e2-4d63396d2be8",
"Answers": "sample string 2"
}
]
},
{
"Id": "18deed35-0fe1-4910-b84b-39fbff4dae2d",
"Questions": [
{
"Id": "58e73289-9bfc-4956-a7e2-4d63396d2be8",
"Answers": "sample string 2"
},
{
"Id": "58e73289-9bfc-4956-a7e2-4d63396d2be8",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "d544dac6-d6d2-4cfb-a62a-c7ad4a150641",
"ContentItemId": "a896c953-7afa-4d94-84c8-b797258b4ecb",
"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-30T02:07:00.6811631+00:00",
"RescheduleDate": "2026-07-30T02:07:00.6811631+00:00"
},
{
"Id": "d544dac6-d6d2-4cfb-a62a-c7ad4a150641",
"ContentItemId": "a896c953-7afa-4d94-84c8-b797258b4ecb",
"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-30T02:07:00.6811631+00:00",
"RescheduleDate": "2026-07-30T02:07:00.6811631+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}