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": "6be58793-921c-4486-9927-9775a6ba9b88",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-07-18T11:19:52.1503201+00:00",
"Registration": {
"Id": "8d4c1eb7-2268-4633-a2d8-72a5ef3f7393",
"UserId": "1484821f-41ed-4ed1-8955-c5818df38859",
"IsCurrent": true,
"CenterId": "08dcc07a-87db-4dc6-bed4-943d48c704cc",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "6a36c0c4-b0ff-44e6-a4c2-ccfc370919c6",
"EndDate": "2026-07-18T11:19:52.1346941+00:00",
"StartDate": "2026-07-18T11:19:52.1346941+00:00",
"SchedulePreferenceDate": "2026-07-18T11:19:52.1346941+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-18T11:19:52.1346941+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "aee7cccf-a4f5-4751-9db5-ab76a536394d",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "f94706b6-1732-4622-902d-4b726fb1af10",
"Sequence": 1,
"AncestorCategoryId": "6243de23-0f75-4d81-a206-4a69713d127d",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "45354e9b-4a24-48f0-9c56-717ab567fbae",
"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": "45354e9b-4a24-48f0-9c56-717ab567fbae",
"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": "aee7cccf-a4f5-4751-9db5-ab76a536394d",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "f94706b6-1732-4622-902d-4b726fb1af10",
"Sequence": 1,
"AncestorCategoryId": "6243de23-0f75-4d81-a206-4a69713d127d",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "45354e9b-4a24-48f0-9c56-717ab567fbae",
"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": "45354e9b-4a24-48f0-9c56-717ab567fbae",
"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": "a5d87e4b-791d-4ac5-9377-28505c988c6c",
"CategoryId": "d19ec82f-7811-4538-bec0-ec2fdba96cb8",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "eec8b8ee-879e-419c-b8e5-e028aa1bdf4b",
"Score": 1.0,
"State": 1
},
{
"Id": "eec8b8ee-879e-419c-b8e5-e028aa1bdf4b",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "ab6e17f5-4e46-450b-9250-17f45b878aef",
"Questions": [
{
"Id": "dd14edaf-4d1d-4073-90d0-ac6155db0b28",
"Answers": "sample string 2"
},
{
"Id": "dd14edaf-4d1d-4073-90d0-ac6155db0b28",
"Answers": "sample string 2"
}
]
},
{
"Id": "ab6e17f5-4e46-450b-9250-17f45b878aef",
"Questions": [
{
"Id": "dd14edaf-4d1d-4073-90d0-ac6155db0b28",
"Answers": "sample string 2"
},
{
"Id": "dd14edaf-4d1d-4073-90d0-ac6155db0b28",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "e700dabb-9708-40d1-8589-bf888a1884ba",
"ContentItemId": "826bdd61-8ada-44e0-a053-8b35e8567e63",
"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-18T11:19:52.1346941+00:00",
"RescheduleDate": "2026-07-18T11:19:52.1346941+00:00"
},
{
"Id": "e700dabb-9708-40d1-8589-bf888a1884ba",
"ContentItemId": "826bdd61-8ada-44e0-a053-8b35e8567e63",
"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-18T11:19:52.1346941+00:00",
"RescheduleDate": "2026-07-18T11:19:52.1346941+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}
text/json
Sample:
{
"UserId": "6be58793-921c-4486-9927-9775a6ba9b88",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-07-18T11:19:52.1815674+00:00",
"Registration": {
"Id": "8d4c1eb7-2268-4633-a2d8-72a5ef3f7393",
"UserId": "1484821f-41ed-4ed1-8955-c5818df38859",
"IsCurrent": true,
"CenterId": "08dcc07a-87db-4dc6-bed4-943d48c704cc",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "6a36c0c4-b0ff-44e6-a4c2-ccfc370919c6",
"EndDate": "2026-07-18T11:19:52.1346941+00:00",
"StartDate": "2026-07-18T11:19:52.1346941+00:00",
"SchedulePreferenceDate": "2026-07-18T11:19:52.1346941+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-18T11:19:52.1346941+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "aee7cccf-a4f5-4751-9db5-ab76a536394d",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "f94706b6-1732-4622-902d-4b726fb1af10",
"Sequence": 1,
"AncestorCategoryId": "6243de23-0f75-4d81-a206-4a69713d127d",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "45354e9b-4a24-48f0-9c56-717ab567fbae",
"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": "45354e9b-4a24-48f0-9c56-717ab567fbae",
"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": "aee7cccf-a4f5-4751-9db5-ab76a536394d",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "f94706b6-1732-4622-902d-4b726fb1af10",
"Sequence": 1,
"AncestorCategoryId": "6243de23-0f75-4d81-a206-4a69713d127d",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "45354e9b-4a24-48f0-9c56-717ab567fbae",
"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": "45354e9b-4a24-48f0-9c56-717ab567fbae",
"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": "a5d87e4b-791d-4ac5-9377-28505c988c6c",
"CategoryId": "d19ec82f-7811-4538-bec0-ec2fdba96cb8",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "eec8b8ee-879e-419c-b8e5-e028aa1bdf4b",
"Score": 1.0,
"State": 1
},
{
"Id": "eec8b8ee-879e-419c-b8e5-e028aa1bdf4b",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "ab6e17f5-4e46-450b-9250-17f45b878aef",
"Questions": [
{
"Id": "dd14edaf-4d1d-4073-90d0-ac6155db0b28",
"Answers": "sample string 2"
},
{
"Id": "dd14edaf-4d1d-4073-90d0-ac6155db0b28",
"Answers": "sample string 2"
}
]
},
{
"Id": "ab6e17f5-4e46-450b-9250-17f45b878aef",
"Questions": [
{
"Id": "dd14edaf-4d1d-4073-90d0-ac6155db0b28",
"Answers": "sample string 2"
},
{
"Id": "dd14edaf-4d1d-4073-90d0-ac6155db0b28",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "e700dabb-9708-40d1-8589-bf888a1884ba",
"ContentItemId": "826bdd61-8ada-44e0-a053-8b35e8567e63",
"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-18T11:19:52.1346941+00:00",
"RescheduleDate": "2026-07-18T11:19:52.1346941+00:00"
},
{
"Id": "e700dabb-9708-40d1-8589-bf888a1884ba",
"ContentItemId": "826bdd61-8ada-44e0-a053-8b35e8567e63",
"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-18T11:19:52.1346941+00:00",
"RescheduleDate": "2026-07-18T11:19:52.1346941+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}