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": "b40ffec2-8441-4e5d-8a33-340b2d7aab9f",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-01-29T00:42:46.3544685+00:00",
"Registration": {
"Id": "1fb43f7e-8d7c-49e9-a79b-28d5f7684e09",
"UserId": "82114b27-866e-4972-acff-872ec9fb28e0",
"IsCurrent": true,
"CenterId": "62e367e8-1a7f-44aa-ad9e-216123aa8ee9",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "c4a8e352-25c7-40c8-b12f-71b7f1b09ee9",
"EndDate": "2026-01-29T00:42:46.3389673+00:00",
"StartDate": "2026-01-29T00:42:46.3389673+00:00",
"SchedulePreferenceDate": "2026-01-29T00:42:46.3389673+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-01-29T00:42:46.3389673+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "16e34a61-f283-4901-847a-1cca576efaf4",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "9d0ed2c3-4de6-457f-824f-937c7f232da7",
"Sequence": 1,
"AncestorCategoryId": "c4000e53-2274-4d85-98b8-2e81d0c3ea5a",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "6f17d5bc-db92-42e6-9a17-310df6b49d27",
"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": "6f17d5bc-db92-42e6-9a17-310df6b49d27",
"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": "16e34a61-f283-4901-847a-1cca576efaf4",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "9d0ed2c3-4de6-457f-824f-937c7f232da7",
"Sequence": 1,
"AncestorCategoryId": "c4000e53-2274-4d85-98b8-2e81d0c3ea5a",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "6f17d5bc-db92-42e6-9a17-310df6b49d27",
"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": "6f17d5bc-db92-42e6-9a17-310df6b49d27",
"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": "3244f2eb-8edc-4ddf-95ce-4da0fece6dbe",
"CategoryId": "94dc460d-44a5-47a2-bcd6-a23da89823a1",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "7be5c17f-eb96-454c-a10d-a3788ac5a51e",
"Score": 1.0,
"State": 1
},
{
"Id": "7be5c17f-eb96-454c-a10d-a3788ac5a51e",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "40d76e07-ca5e-4dff-bad8-4c7d433d4011",
"Questions": [
{
"Id": "5f4d042e-778d-4ae2-9270-cd6919a07683",
"Answers": "sample string 2"
},
{
"Id": "5f4d042e-778d-4ae2-9270-cd6919a07683",
"Answers": "sample string 2"
}
]
},
{
"Id": "40d76e07-ca5e-4dff-bad8-4c7d433d4011",
"Questions": [
{
"Id": "5f4d042e-778d-4ae2-9270-cd6919a07683",
"Answers": "sample string 2"
},
{
"Id": "5f4d042e-778d-4ae2-9270-cd6919a07683",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "1b318bdc-5a8a-4986-aa6b-8f7736b25b19",
"ContentItemId": "933f736a-6a62-4974-8942-ca14fee36bfa",
"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-01-29T00:42:46.3389673+00:00",
"RescheduleDate": "2026-01-29T00:42:46.3389673+00:00"
},
{
"Id": "1b318bdc-5a8a-4986-aa6b-8f7736b25b19",
"ContentItemId": "933f736a-6a62-4974-8942-ca14fee36bfa",
"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-01-29T00:42:46.3389673+00:00",
"RescheduleDate": "2026-01-29T00:42:46.3389673+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}
text/json
Sample:
{
"UserId": "b40ffec2-8441-4e5d-8a33-340b2d7aab9f",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-01-29T00:42:46.3701021+00:00",
"Registration": {
"Id": "1fb43f7e-8d7c-49e9-a79b-28d5f7684e09",
"UserId": "82114b27-866e-4972-acff-872ec9fb28e0",
"IsCurrent": true,
"CenterId": "62e367e8-1a7f-44aa-ad9e-216123aa8ee9",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "c4a8e352-25c7-40c8-b12f-71b7f1b09ee9",
"EndDate": "2026-01-29T00:42:46.3389673+00:00",
"StartDate": "2026-01-29T00:42:46.3389673+00:00",
"SchedulePreferenceDate": "2026-01-29T00:42:46.3389673+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-01-29T00:42:46.3389673+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "16e34a61-f283-4901-847a-1cca576efaf4",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "9d0ed2c3-4de6-457f-824f-937c7f232da7",
"Sequence": 1,
"AncestorCategoryId": "c4000e53-2274-4d85-98b8-2e81d0c3ea5a",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "6f17d5bc-db92-42e6-9a17-310df6b49d27",
"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": "6f17d5bc-db92-42e6-9a17-310df6b49d27",
"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": "16e34a61-f283-4901-847a-1cca576efaf4",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "9d0ed2c3-4de6-457f-824f-937c7f232da7",
"Sequence": 1,
"AncestorCategoryId": "c4000e53-2274-4d85-98b8-2e81d0c3ea5a",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "6f17d5bc-db92-42e6-9a17-310df6b49d27",
"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": "6f17d5bc-db92-42e6-9a17-310df6b49d27",
"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": "3244f2eb-8edc-4ddf-95ce-4da0fece6dbe",
"CategoryId": "94dc460d-44a5-47a2-bcd6-a23da89823a1",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "7be5c17f-eb96-454c-a10d-a3788ac5a51e",
"Score": 1.0,
"State": 1
},
{
"Id": "7be5c17f-eb96-454c-a10d-a3788ac5a51e",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "40d76e07-ca5e-4dff-bad8-4c7d433d4011",
"Questions": [
{
"Id": "5f4d042e-778d-4ae2-9270-cd6919a07683",
"Answers": "sample string 2"
},
{
"Id": "5f4d042e-778d-4ae2-9270-cd6919a07683",
"Answers": "sample string 2"
}
]
},
{
"Id": "40d76e07-ca5e-4dff-bad8-4c7d433d4011",
"Questions": [
{
"Id": "5f4d042e-778d-4ae2-9270-cd6919a07683",
"Answers": "sample string 2"
},
{
"Id": "5f4d042e-778d-4ae2-9270-cd6919a07683",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "1b318bdc-5a8a-4986-aa6b-8f7736b25b19",
"ContentItemId": "933f736a-6a62-4974-8942-ca14fee36bfa",
"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-01-29T00:42:46.3389673+00:00",
"RescheduleDate": "2026-01-29T00:42:46.3389673+00:00"
},
{
"Id": "1b318bdc-5a8a-4986-aa6b-8f7736b25b19",
"ContentItemId": "933f736a-6a62-4974-8942-ca14fee36bfa",
"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-01-29T00:42:46.3389673+00:00",
"RescheduleDate": "2026-01-29T00:42:46.3389673+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}