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": "67f05c81-f31b-4526-a6f6-d6805b7e827e",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-09-29T05:35:15.0291327+00:00",
"Registration": {
"Id": "e32d5377-bc28-4385-bd0f-1151b5e103f2",
"UserId": "eb8ba50c-d857-420e-9da3-9250f4ea9852",
"IsCurrent": true,
"CenterId": "3d869458-cf24-441b-98e8-80b2fcd7c1f7",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "f4500af2-ce86-4a32-b0a1-f594931e839c",
"EndDate": "2026-09-29T05:35:15.0291327+00:00",
"StartDate": "2026-09-29T05:35:15.0291327+00:00",
"SchedulePreferenceDate": "2026-09-29T05:35:15.0291327+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-09-29T05:35:15.0291327+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "73801ec6-86f2-431c-acaa-2d74b2ba8302",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "8e666dd0-8827-4688-8909-e3106de7014b",
"Sequence": 1,
"AncestorCategoryId": "17c64ed1-f223-4959-a183-60210bda8d9b",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "5c48c340-3e48-40ee-8075-de0ea0a3ba16",
"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": "5c48c340-3e48-40ee-8075-de0ea0a3ba16",
"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": "73801ec6-86f2-431c-acaa-2d74b2ba8302",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "8e666dd0-8827-4688-8909-e3106de7014b",
"Sequence": 1,
"AncestorCategoryId": "17c64ed1-f223-4959-a183-60210bda8d9b",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "5c48c340-3e48-40ee-8075-de0ea0a3ba16",
"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": "5c48c340-3e48-40ee-8075-de0ea0a3ba16",
"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": "f29a866e-d7e9-49cf-8cde-0926e5081fd3",
"CategoryId": "b64901fd-e983-4c1f-8842-b620215ad4e4",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "16240085-4f4c-49bb-a293-e2dc863761ab",
"Score": 1.0,
"State": 1
},
{
"Id": "16240085-4f4c-49bb-a293-e2dc863761ab",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "7a04dc11-1d83-4200-9c83-3bdca0625070",
"Questions": [
{
"Id": "32a971ba-270d-4f6d-84a5-fd5c0f55e176",
"Answers": "sample string 2"
},
{
"Id": "32a971ba-270d-4f6d-84a5-fd5c0f55e176",
"Answers": "sample string 2"
}
]
},
{
"Id": "7a04dc11-1d83-4200-9c83-3bdca0625070",
"Questions": [
{
"Id": "32a971ba-270d-4f6d-84a5-fd5c0f55e176",
"Answers": "sample string 2"
},
{
"Id": "32a971ba-270d-4f6d-84a5-fd5c0f55e176",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "6ae72370-8007-4ab9-93ae-7e14ea409563",
"ContentItemId": "11040724-d475-4a7a-8c4b-064ac2447573",
"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-09-29T05:35:15.0291327+00:00",
"RescheduleDate": "2026-09-29T05:35:15.0291327+00:00"
},
{
"Id": "6ae72370-8007-4ab9-93ae-7e14ea409563",
"ContentItemId": "11040724-d475-4a7a-8c4b-064ac2447573",
"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-09-29T05:35:15.0291327+00:00",
"RescheduleDate": "2026-09-29T05:35:15.0291327+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}
text/json
Sample:
{
"UserId": "67f05c81-f31b-4526-a6f6-d6805b7e827e",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-09-29T05:35:15.0603785+00:00",
"Registration": {
"Id": "e32d5377-bc28-4385-bd0f-1151b5e103f2",
"UserId": "eb8ba50c-d857-420e-9da3-9250f4ea9852",
"IsCurrent": true,
"CenterId": "3d869458-cf24-441b-98e8-80b2fcd7c1f7",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "f4500af2-ce86-4a32-b0a1-f594931e839c",
"EndDate": "2026-09-29T05:35:15.0291327+00:00",
"StartDate": "2026-09-29T05:35:15.0291327+00:00",
"SchedulePreferenceDate": "2026-09-29T05:35:15.0291327+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-09-29T05:35:15.0291327+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "73801ec6-86f2-431c-acaa-2d74b2ba8302",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "8e666dd0-8827-4688-8909-e3106de7014b",
"Sequence": 1,
"AncestorCategoryId": "17c64ed1-f223-4959-a183-60210bda8d9b",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "5c48c340-3e48-40ee-8075-de0ea0a3ba16",
"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": "5c48c340-3e48-40ee-8075-de0ea0a3ba16",
"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": "73801ec6-86f2-431c-acaa-2d74b2ba8302",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "8e666dd0-8827-4688-8909-e3106de7014b",
"Sequence": 1,
"AncestorCategoryId": "17c64ed1-f223-4959-a183-60210bda8d9b",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "5c48c340-3e48-40ee-8075-de0ea0a3ba16",
"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": "5c48c340-3e48-40ee-8075-de0ea0a3ba16",
"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": "f29a866e-d7e9-49cf-8cde-0926e5081fd3",
"CategoryId": "b64901fd-e983-4c1f-8842-b620215ad4e4",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "16240085-4f4c-49bb-a293-e2dc863761ab",
"Score": 1.0,
"State": 1
},
{
"Id": "16240085-4f4c-49bb-a293-e2dc863761ab",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "7a04dc11-1d83-4200-9c83-3bdca0625070",
"Questions": [
{
"Id": "32a971ba-270d-4f6d-84a5-fd5c0f55e176",
"Answers": "sample string 2"
},
{
"Id": "32a971ba-270d-4f6d-84a5-fd5c0f55e176",
"Answers": "sample string 2"
}
]
},
{
"Id": "7a04dc11-1d83-4200-9c83-3bdca0625070",
"Questions": [
{
"Id": "32a971ba-270d-4f6d-84a5-fd5c0f55e176",
"Answers": "sample string 2"
},
{
"Id": "32a971ba-270d-4f6d-84a5-fd5c0f55e176",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "6ae72370-8007-4ab9-93ae-7e14ea409563",
"ContentItemId": "11040724-d475-4a7a-8c4b-064ac2447573",
"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-09-29T05:35:15.0291327+00:00",
"RescheduleDate": "2026-09-29T05:35:15.0291327+00:00"
},
{
"Id": "6ae72370-8007-4ab9-93ae-7e14ea409563",
"ContentItemId": "11040724-d475-4a7a-8c4b-064ac2447573",
"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-09-29T05:35:15.0291327+00:00",
"RescheduleDate": "2026-09-29T05:35:15.0291327+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}