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": "2e718ff1-f7d2-4830-9540-11a3fe7d66d2",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-07-06T12:20:32.1131937+00:00",
"Registration": {
"Id": "80211987-1ea4-4136-af4a-36f07eedee9f",
"UserId": "32ce6e8b-f02f-4d2c-b5f3-f4e22093c392",
"IsCurrent": true,
"CenterId": "3c2b8ece-e0a3-443a-be97-5ea5e7af709e",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "cd06d193-c91e-43d5-bee0-bcbd6167f9a4",
"EndDate": "2026-07-06T12:20:32.0975959+00:00",
"StartDate": "2026-07-06T12:20:32.0975959+00:00",
"SchedulePreferenceDate": "2026-07-06T12:20:32.0975959+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-07-06T12:20:32.0975959+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "e27d0622-af16-4e19-9b93-f77f0138b515",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "4bd348bc-6cb3-49a6-a436-8a173c070c29",
"Sequence": 1,
"AncestorCategoryId": "1a6b6fda-7dc1-4c02-bb7f-07ac94407764",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "ae4b2521-c005-4f8a-be4b-51980d744829",
"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": "ae4b2521-c005-4f8a-be4b-51980d744829",
"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": "e27d0622-af16-4e19-9b93-f77f0138b515",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "4bd348bc-6cb3-49a6-a436-8a173c070c29",
"Sequence": 1,
"AncestorCategoryId": "1a6b6fda-7dc1-4c02-bb7f-07ac94407764",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "ae4b2521-c005-4f8a-be4b-51980d744829",
"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": "ae4b2521-c005-4f8a-be4b-51980d744829",
"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": "a1cac5a6-36ae-4e89-915d-d0fb57f0af8d",
"CategoryId": "76c58511-1920-4663-ba16-b355f575332d",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "336ec1dd-b34f-4608-a98d-d53b8d158ce9",
"Score": 1.0,
"State": 1
},
{
"Id": "336ec1dd-b34f-4608-a98d-d53b8d158ce9",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "f6d39f41-9a75-4792-a96b-f39a27945b7a",
"Questions": [
{
"Id": "fd75ef10-6021-4932-89e4-635f671587fc",
"Answers": "sample string 2"
},
{
"Id": "fd75ef10-6021-4932-89e4-635f671587fc",
"Answers": "sample string 2"
}
]
},
{
"Id": "f6d39f41-9a75-4792-a96b-f39a27945b7a",
"Questions": [
{
"Id": "fd75ef10-6021-4932-89e4-635f671587fc",
"Answers": "sample string 2"
},
{
"Id": "fd75ef10-6021-4932-89e4-635f671587fc",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "23e7924f-4a49-4761-bd65-2bb6ea2ba5ca",
"ContentItemId": "974a0b15-165b-410c-9bd3-597a2cd8de34",
"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-07-06T12:20:32.0975959+00:00",
"RescheduleDate": "2026-07-06T12:20:32.0975959+00:00"
},
{
"Id": "23e7924f-4a49-4761-bd65-2bb6ea2ba5ca",
"ContentItemId": "974a0b15-165b-410c-9bd3-597a2cd8de34",
"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-07-06T12:20:32.0975959+00:00",
"RescheduleDate": "2026-07-06T12:20:32.0975959+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}
text/json
Sample:
{
"UserId": "2e718ff1-f7d2-4830-9540-11a3fe7d66d2",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-07-06T12:20:32.1444499+00:00",
"Registration": {
"Id": "80211987-1ea4-4136-af4a-36f07eedee9f",
"UserId": "32ce6e8b-f02f-4d2c-b5f3-f4e22093c392",
"IsCurrent": true,
"CenterId": "3c2b8ece-e0a3-443a-be97-5ea5e7af709e",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "cd06d193-c91e-43d5-bee0-bcbd6167f9a4",
"EndDate": "2026-07-06T12:20:32.0975959+00:00",
"StartDate": "2026-07-06T12:20:32.0975959+00:00",
"SchedulePreferenceDate": "2026-07-06T12:20:32.0975959+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-07-06T12:20:32.0975959+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "e27d0622-af16-4e19-9b93-f77f0138b515",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "4bd348bc-6cb3-49a6-a436-8a173c070c29",
"Sequence": 1,
"AncestorCategoryId": "1a6b6fda-7dc1-4c02-bb7f-07ac94407764",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "ae4b2521-c005-4f8a-be4b-51980d744829",
"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": "ae4b2521-c005-4f8a-be4b-51980d744829",
"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": "e27d0622-af16-4e19-9b93-f77f0138b515",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "4bd348bc-6cb3-49a6-a436-8a173c070c29",
"Sequence": 1,
"AncestorCategoryId": "1a6b6fda-7dc1-4c02-bb7f-07ac94407764",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "ae4b2521-c005-4f8a-be4b-51980d744829",
"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": "ae4b2521-c005-4f8a-be4b-51980d744829",
"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": "a1cac5a6-36ae-4e89-915d-d0fb57f0af8d",
"CategoryId": "76c58511-1920-4663-ba16-b355f575332d",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "336ec1dd-b34f-4608-a98d-d53b8d158ce9",
"Score": 1.0,
"State": 1
},
{
"Id": "336ec1dd-b34f-4608-a98d-d53b8d158ce9",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "f6d39f41-9a75-4792-a96b-f39a27945b7a",
"Questions": [
{
"Id": "fd75ef10-6021-4932-89e4-635f671587fc",
"Answers": "sample string 2"
},
{
"Id": "fd75ef10-6021-4932-89e4-635f671587fc",
"Answers": "sample string 2"
}
]
},
{
"Id": "f6d39f41-9a75-4792-a96b-f39a27945b7a",
"Questions": [
{
"Id": "fd75ef10-6021-4932-89e4-635f671587fc",
"Answers": "sample string 2"
},
{
"Id": "fd75ef10-6021-4932-89e4-635f671587fc",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "23e7924f-4a49-4761-bd65-2bb6ea2ba5ca",
"ContentItemId": "974a0b15-165b-410c-9bd3-597a2cd8de34",
"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-07-06T12:20:32.0975959+00:00",
"RescheduleDate": "2026-07-06T12:20:32.0975959+00:00"
},
{
"Id": "23e7924f-4a49-4761-bd65-2bb6ea2ba5ca",
"ContentItemId": "974a0b15-165b-410c-9bd3-597a2cd8de34",
"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-07-06T12:20:32.0975959+00:00",
"RescheduleDate": "2026-07-06T12:20:32.0975959+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}