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": "a1906560-49fd-47e7-90aa-f12d7a3fc043",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-06-17T13:10:04.118785+00:00",
"Registration": {
"Id": "1ac95c37-f557-4440-ba8b-41513b5405e1",
"UserId": "dc90f62f-ee0f-4f95-bbbd-c72171b0023e",
"IsCurrent": true,
"CenterId": "907ca107-6d9e-4668-94f8-8e8a8055e1e3",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "1db94321-52a3-4d05-afc9-b9019ce160f2",
"EndDate": "2026-06-17T13:10:04.1031564+00:00",
"StartDate": "2026-06-17T13:10:04.1031564+00:00",
"SchedulePreferenceDate": "2026-06-17T13:10:04.1031564+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-17T13:10:04.1031564+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "61b2b55b-ebb1-44d7-87ca-d6e955f4c010",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "0c86d8ae-c730-46bd-bd54-3edf05872848",
"Sequence": 1,
"AncestorCategoryId": "f2a75ba4-1b36-4d73-b3db-f6a95c2f5745",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "413dea17-e520-4a3c-8c41-df273f4db54e",
"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": "413dea17-e520-4a3c-8c41-df273f4db54e",
"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": "61b2b55b-ebb1-44d7-87ca-d6e955f4c010",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "0c86d8ae-c730-46bd-bd54-3edf05872848",
"Sequence": 1,
"AncestorCategoryId": "f2a75ba4-1b36-4d73-b3db-f6a95c2f5745",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "413dea17-e520-4a3c-8c41-df273f4db54e",
"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": "413dea17-e520-4a3c-8c41-df273f4db54e",
"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": "a578e65f-6504-4d17-90b4-93987ae26cad",
"CategoryId": "758a3d00-15b0-4b0b-9c5b-f0a82d069551",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "7512891d-13ee-4e9a-8eb5-9ed91fe8e76c",
"Score": 1.0,
"State": 1
},
{
"Id": "7512891d-13ee-4e9a-8eb5-9ed91fe8e76c",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "41dd301a-a50c-4e9f-8788-3e7758cbb02f",
"Questions": [
{
"Id": "c945f4d1-34cd-475f-a8c6-e79bff7b7c22",
"Answers": "sample string 2"
},
{
"Id": "c945f4d1-34cd-475f-a8c6-e79bff7b7c22",
"Answers": "sample string 2"
}
]
},
{
"Id": "41dd301a-a50c-4e9f-8788-3e7758cbb02f",
"Questions": [
{
"Id": "c945f4d1-34cd-475f-a8c6-e79bff7b7c22",
"Answers": "sample string 2"
},
{
"Id": "c945f4d1-34cd-475f-a8c6-e79bff7b7c22",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "0ef0c9c9-7b66-463e-b217-0a8606ecf6ff",
"ContentItemId": "7f61aeb7-b072-4994-9e11-ea38cbe2f971",
"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-17T13:10:04.1031564+00:00",
"RescheduleDate": "2026-06-17T13:10:04.1031564+00:00"
},
{
"Id": "0ef0c9c9-7b66-463e-b217-0a8606ecf6ff",
"ContentItemId": "7f61aeb7-b072-4994-9e11-ea38cbe2f971",
"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-17T13:10:04.1031564+00:00",
"RescheduleDate": "2026-06-17T13:10:04.1031564+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}
text/json
Sample:
{
"UserId": "a1906560-49fd-47e7-90aa-f12d7a3fc043",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-06-17T13:10:04.1656691+00:00",
"Registration": {
"Id": "1ac95c37-f557-4440-ba8b-41513b5405e1",
"UserId": "dc90f62f-ee0f-4f95-bbbd-c72171b0023e",
"IsCurrent": true,
"CenterId": "907ca107-6d9e-4668-94f8-8e8a8055e1e3",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "1db94321-52a3-4d05-afc9-b9019ce160f2",
"EndDate": "2026-06-17T13:10:04.1031564+00:00",
"StartDate": "2026-06-17T13:10:04.1031564+00:00",
"SchedulePreferenceDate": "2026-06-17T13:10:04.1031564+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-17T13:10:04.1031564+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "61b2b55b-ebb1-44d7-87ca-d6e955f4c010",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "0c86d8ae-c730-46bd-bd54-3edf05872848",
"Sequence": 1,
"AncestorCategoryId": "f2a75ba4-1b36-4d73-b3db-f6a95c2f5745",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "413dea17-e520-4a3c-8c41-df273f4db54e",
"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": "413dea17-e520-4a3c-8c41-df273f4db54e",
"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": "61b2b55b-ebb1-44d7-87ca-d6e955f4c010",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "0c86d8ae-c730-46bd-bd54-3edf05872848",
"Sequence": 1,
"AncestorCategoryId": "f2a75ba4-1b36-4d73-b3db-f6a95c2f5745",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "413dea17-e520-4a3c-8c41-df273f4db54e",
"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": "413dea17-e520-4a3c-8c41-df273f4db54e",
"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": "a578e65f-6504-4d17-90b4-93987ae26cad",
"CategoryId": "758a3d00-15b0-4b0b-9c5b-f0a82d069551",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "7512891d-13ee-4e9a-8eb5-9ed91fe8e76c",
"Score": 1.0,
"State": 1
},
{
"Id": "7512891d-13ee-4e9a-8eb5-9ed91fe8e76c",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "41dd301a-a50c-4e9f-8788-3e7758cbb02f",
"Questions": [
{
"Id": "c945f4d1-34cd-475f-a8c6-e79bff7b7c22",
"Answers": "sample string 2"
},
{
"Id": "c945f4d1-34cd-475f-a8c6-e79bff7b7c22",
"Answers": "sample string 2"
}
]
},
{
"Id": "41dd301a-a50c-4e9f-8788-3e7758cbb02f",
"Questions": [
{
"Id": "c945f4d1-34cd-475f-a8c6-e79bff7b7c22",
"Answers": "sample string 2"
},
{
"Id": "c945f4d1-34cd-475f-a8c6-e79bff7b7c22",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "0ef0c9c9-7b66-463e-b217-0a8606ecf6ff",
"ContentItemId": "7f61aeb7-b072-4994-9e11-ea38cbe2f971",
"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-17T13:10:04.1031564+00:00",
"RescheduleDate": "2026-06-17T13:10:04.1031564+00:00"
},
{
"Id": "0ef0c9c9-7b66-463e-b217-0a8606ecf6ff",
"ContentItemId": "7f61aeb7-b072-4994-9e11-ea38cbe2f971",
"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-17T13:10:04.1031564+00:00",
"RescheduleDate": "2026-06-17T13:10:04.1031564+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}