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": "5cca61f4-9353-4ea9-807f-524925b04793",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-08-18T12:55:11.7941953+00:00",
"Registration": {
"Id": "d968641b-22d5-4b74-9bb3-7fe8a8c4ebfe",
"UserId": "7cf8af55-5d11-45c2-b0f5-97688444adbb",
"IsCurrent": true,
"CenterId": "f80407c7-8c6e-441d-9be4-2461a34e34f1",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "4176d19a-8f21-4da9-8f3d-24218c3b4a41",
"EndDate": "2026-08-18T12:55:11.7785735+00:00",
"StartDate": "2026-08-18T12:55:11.7785735+00:00",
"SchedulePreferenceDate": "2026-08-18T12:55:11.7785735+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-08-18T12:55:11.7785735+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "c412494e-b4bd-48ec-9432-8b01da917ce9",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "9e92a087-89f1-4014-bd87-28ef558410cb",
"Sequence": 1,
"AncestorCategoryId": "15ad9c54-6706-4eb2-a737-48e6fb6ab24a",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "4038dc2c-6115-47d2-90b7-e599526f0e0f",
"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": "4038dc2c-6115-47d2-90b7-e599526f0e0f",
"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": "c412494e-b4bd-48ec-9432-8b01da917ce9",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "9e92a087-89f1-4014-bd87-28ef558410cb",
"Sequence": 1,
"AncestorCategoryId": "15ad9c54-6706-4eb2-a737-48e6fb6ab24a",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "4038dc2c-6115-47d2-90b7-e599526f0e0f",
"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": "4038dc2c-6115-47d2-90b7-e599526f0e0f",
"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": "14aedbec-00a2-4989-9da6-2551e7c17488",
"CategoryId": "d0493a3e-9a20-4ca7-9b6d-4d3cfd5fb2fc",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "8474738a-c87c-4ae0-b0de-c3ff7b689344",
"Score": 1.0,
"State": 1
},
{
"Id": "8474738a-c87c-4ae0-b0de-c3ff7b689344",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "c26c2011-bbea-4d88-b10b-1ac07d4774f9",
"Questions": [
{
"Id": "6c33735d-72e8-430c-87cc-2d4d07bf7bb2",
"Answers": "sample string 2"
},
{
"Id": "6c33735d-72e8-430c-87cc-2d4d07bf7bb2",
"Answers": "sample string 2"
}
]
},
{
"Id": "c26c2011-bbea-4d88-b10b-1ac07d4774f9",
"Questions": [
{
"Id": "6c33735d-72e8-430c-87cc-2d4d07bf7bb2",
"Answers": "sample string 2"
},
{
"Id": "6c33735d-72e8-430c-87cc-2d4d07bf7bb2",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "5e21d209-8711-490c-8426-1a4c003e105b",
"ContentItemId": "77f9cf82-e4ff-4b10-91c6-012cdd147f62",
"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-08-18T12:55:11.7941953+00:00",
"RescheduleDate": "2026-08-18T12:55:11.7941953+00:00"
},
{
"Id": "5e21d209-8711-490c-8426-1a4c003e105b",
"ContentItemId": "77f9cf82-e4ff-4b10-91c6-012cdd147f62",
"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-08-18T12:55:11.7941953+00:00",
"RescheduleDate": "2026-08-18T12:55:11.7941953+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}
text/json
Sample:
{
"UserId": "5cca61f4-9353-4ea9-807f-524925b04793",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-08-18T12:55:11.8410746+00:00",
"Registration": {
"Id": "d968641b-22d5-4b74-9bb3-7fe8a8c4ebfe",
"UserId": "7cf8af55-5d11-45c2-b0f5-97688444adbb",
"IsCurrent": true,
"CenterId": "f80407c7-8c6e-441d-9be4-2461a34e34f1",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "4176d19a-8f21-4da9-8f3d-24218c3b4a41",
"EndDate": "2026-08-18T12:55:11.7785735+00:00",
"StartDate": "2026-08-18T12:55:11.7785735+00:00",
"SchedulePreferenceDate": "2026-08-18T12:55:11.7785735+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-08-18T12:55:11.7785735+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "c412494e-b4bd-48ec-9432-8b01da917ce9",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "9e92a087-89f1-4014-bd87-28ef558410cb",
"Sequence": 1,
"AncestorCategoryId": "15ad9c54-6706-4eb2-a737-48e6fb6ab24a",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "4038dc2c-6115-47d2-90b7-e599526f0e0f",
"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": "4038dc2c-6115-47d2-90b7-e599526f0e0f",
"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": "c412494e-b4bd-48ec-9432-8b01da917ce9",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "9e92a087-89f1-4014-bd87-28ef558410cb",
"Sequence": 1,
"AncestorCategoryId": "15ad9c54-6706-4eb2-a737-48e6fb6ab24a",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "4038dc2c-6115-47d2-90b7-e599526f0e0f",
"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": "4038dc2c-6115-47d2-90b7-e599526f0e0f",
"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": "14aedbec-00a2-4989-9da6-2551e7c17488",
"CategoryId": "d0493a3e-9a20-4ca7-9b6d-4d3cfd5fb2fc",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "8474738a-c87c-4ae0-b0de-c3ff7b689344",
"Score": 1.0,
"State": 1
},
{
"Id": "8474738a-c87c-4ae0-b0de-c3ff7b689344",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "c26c2011-bbea-4d88-b10b-1ac07d4774f9",
"Questions": [
{
"Id": "6c33735d-72e8-430c-87cc-2d4d07bf7bb2",
"Answers": "sample string 2"
},
{
"Id": "6c33735d-72e8-430c-87cc-2d4d07bf7bb2",
"Answers": "sample string 2"
}
]
},
{
"Id": "c26c2011-bbea-4d88-b10b-1ac07d4774f9",
"Questions": [
{
"Id": "6c33735d-72e8-430c-87cc-2d4d07bf7bb2",
"Answers": "sample string 2"
},
{
"Id": "6c33735d-72e8-430c-87cc-2d4d07bf7bb2",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "5e21d209-8711-490c-8426-1a4c003e105b",
"ContentItemId": "77f9cf82-e4ff-4b10-91c6-012cdd147f62",
"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-08-18T12:55:11.7941953+00:00",
"RescheduleDate": "2026-08-18T12:55:11.7941953+00:00"
},
{
"Id": "5e21d209-8711-490c-8426-1a4c003e105b",
"ContentItemId": "77f9cf82-e4ff-4b10-91c6-012cdd147f62",
"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-08-18T12:55:11.7941953+00:00",
"RescheduleDate": "2026-08-18T12:55:11.7941953+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}