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": "cf54b571-e583-4a08-9b5e-220164fbb59a",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-06-17T19:27:49.1728314+00:00",
"Registration": {
"Id": "2ee86514-218c-4f79-8baa-5030f41394c6",
"UserId": "aa295e68-6789-4663-8337-28d520976bbc",
"IsCurrent": true,
"CenterId": "323e3ce3-0a98-4ec4-ac5b-a364b382e31f",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "2338a6f8-403f-45b8-a770-4c2acd542781",
"EndDate": "2026-06-17T19:27:49.1728314+00:00",
"StartDate": "2026-06-17T19:27:49.1728314+00:00",
"SchedulePreferenceDate": "2026-06-17T19:27:49.1728314+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-17T19:27:49.1728314+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "31553002-8b88-4842-8817-8af70828363b",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "9076354e-87c3-4fdc-ac1a-22dedea52778",
"Sequence": 1,
"AncestorCategoryId": "6d3af80f-b717-429b-8631-1b6238217f7f",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "a673df7f-e44c-4c47-aba4-384ae32ffae8",
"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": "a673df7f-e44c-4c47-aba4-384ae32ffae8",
"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": "31553002-8b88-4842-8817-8af70828363b",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "9076354e-87c3-4fdc-ac1a-22dedea52778",
"Sequence": 1,
"AncestorCategoryId": "6d3af80f-b717-429b-8631-1b6238217f7f",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "a673df7f-e44c-4c47-aba4-384ae32ffae8",
"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": "a673df7f-e44c-4c47-aba4-384ae32ffae8",
"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": "4c21ae0e-eefa-4315-a35d-109637043196",
"CategoryId": "68d48f1e-dd54-4f7b-b1db-9cd86a5c9c50",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "9839b07a-1257-449b-a779-c9e4c20de277",
"Score": 1.0,
"State": 1
},
{
"Id": "9839b07a-1257-449b-a779-c9e4c20de277",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "fd84348d-c59d-410d-b038-674af0351c1a",
"Questions": [
{
"Id": "9db2a5bd-a9b6-45d3-ad66-f52d2c0294c8",
"Answers": "sample string 2"
},
{
"Id": "9db2a5bd-a9b6-45d3-ad66-f52d2c0294c8",
"Answers": "sample string 2"
}
]
},
{
"Id": "fd84348d-c59d-410d-b038-674af0351c1a",
"Questions": [
{
"Id": "9db2a5bd-a9b6-45d3-ad66-f52d2c0294c8",
"Answers": "sample string 2"
},
{
"Id": "9db2a5bd-a9b6-45d3-ad66-f52d2c0294c8",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "b6e134fa-344d-4434-9b51-c5f7c55d0c9b",
"ContentItemId": "646eaa71-c80e-41e4-8e45-2aeaaa731f85",
"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-17T19:27:49.1728314+00:00",
"RescheduleDate": "2026-06-17T19:27:49.1728314+00:00"
},
{
"Id": "b6e134fa-344d-4434-9b51-c5f7c55d0c9b",
"ContentItemId": "646eaa71-c80e-41e4-8e45-2aeaaa731f85",
"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-17T19:27:49.1728314+00:00",
"RescheduleDate": "2026-06-17T19:27:49.1728314+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}
text/json
Sample:
{
"UserId": "cf54b571-e583-4a08-9b5e-220164fbb59a",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-06-17T19:27:49.2040794+00:00",
"Registration": {
"Id": "2ee86514-218c-4f79-8baa-5030f41394c6",
"UserId": "aa295e68-6789-4663-8337-28d520976bbc",
"IsCurrent": true,
"CenterId": "323e3ce3-0a98-4ec4-ac5b-a364b382e31f",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "2338a6f8-403f-45b8-a770-4c2acd542781",
"EndDate": "2026-06-17T19:27:49.1728314+00:00",
"StartDate": "2026-06-17T19:27:49.1728314+00:00",
"SchedulePreferenceDate": "2026-06-17T19:27:49.1728314+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-17T19:27:49.1728314+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "31553002-8b88-4842-8817-8af70828363b",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "9076354e-87c3-4fdc-ac1a-22dedea52778",
"Sequence": 1,
"AncestorCategoryId": "6d3af80f-b717-429b-8631-1b6238217f7f",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "a673df7f-e44c-4c47-aba4-384ae32ffae8",
"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": "a673df7f-e44c-4c47-aba4-384ae32ffae8",
"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": "31553002-8b88-4842-8817-8af70828363b",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "9076354e-87c3-4fdc-ac1a-22dedea52778",
"Sequence": 1,
"AncestorCategoryId": "6d3af80f-b717-429b-8631-1b6238217f7f",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "a673df7f-e44c-4c47-aba4-384ae32ffae8",
"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": "a673df7f-e44c-4c47-aba4-384ae32ffae8",
"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": "4c21ae0e-eefa-4315-a35d-109637043196",
"CategoryId": "68d48f1e-dd54-4f7b-b1db-9cd86a5c9c50",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "9839b07a-1257-449b-a779-c9e4c20de277",
"Score": 1.0,
"State": 1
},
{
"Id": "9839b07a-1257-449b-a779-c9e4c20de277",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "fd84348d-c59d-410d-b038-674af0351c1a",
"Questions": [
{
"Id": "9db2a5bd-a9b6-45d3-ad66-f52d2c0294c8",
"Answers": "sample string 2"
},
{
"Id": "9db2a5bd-a9b6-45d3-ad66-f52d2c0294c8",
"Answers": "sample string 2"
}
]
},
{
"Id": "fd84348d-c59d-410d-b038-674af0351c1a",
"Questions": [
{
"Id": "9db2a5bd-a9b6-45d3-ad66-f52d2c0294c8",
"Answers": "sample string 2"
},
{
"Id": "9db2a5bd-a9b6-45d3-ad66-f52d2c0294c8",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "b6e134fa-344d-4434-9b51-c5f7c55d0c9b",
"ContentItemId": "646eaa71-c80e-41e4-8e45-2aeaaa731f85",
"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-17T19:27:49.1728314+00:00",
"RescheduleDate": "2026-06-17T19:27:49.1728314+00:00"
},
{
"Id": "b6e134fa-344d-4434-9b51-c5f7c55d0c9b",
"ContentItemId": "646eaa71-c80e-41e4-8e45-2aeaaa731f85",
"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-17T19:27:49.1728314+00:00",
"RescheduleDate": "2026-06-17T19:27:49.1728314+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}