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": "a56f3db4-6f58-44be-942b-7cdf3328d124",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-07-21T07:11:18.7084765+00:00",
"Registration": {
"Id": "feff4b17-31a4-4a58-8275-363aa6cbb685",
"UserId": "80cc717a-7fae-48c8-a605-887899ffc2e5",
"IsCurrent": true,
"CenterId": "6698786b-aa84-4f02-8808-7b939d81048f",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "5f2839e7-dd30-40bb-9da9-bea2e1aade18",
"EndDate": "2026-07-21T07:11:18.6928522+00:00",
"StartDate": "2026-07-21T07:11:18.6928522+00:00",
"SchedulePreferenceDate": "2026-07-21T07:11:18.6928522+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-21T07:11:18.6928522+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "8a3f3e22-c460-4780-8bc0-e2fde8f19bd6",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "10f50d0f-325b-4415-bc1c-e3b7ef409f9b",
"Sequence": 1,
"AncestorCategoryId": "4c786073-dd07-4c8b-b4fb-814743a21426",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "f8779c39-5ac4-4547-9426-9583e64c0cd8",
"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": "f8779c39-5ac4-4547-9426-9583e64c0cd8",
"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": "8a3f3e22-c460-4780-8bc0-e2fde8f19bd6",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "10f50d0f-325b-4415-bc1c-e3b7ef409f9b",
"Sequence": 1,
"AncestorCategoryId": "4c786073-dd07-4c8b-b4fb-814743a21426",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "f8779c39-5ac4-4547-9426-9583e64c0cd8",
"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": "f8779c39-5ac4-4547-9426-9583e64c0cd8",
"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": "08de2bc1-41cb-4d28-8cc0-a1ec522ffe44",
"CategoryId": "d946abc9-6f88-409d-af67-b59a49c37e25",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "36394236-f715-4ff3-8402-0b8dffbf29d8",
"Score": 1.0,
"State": 1
},
{
"Id": "36394236-f715-4ff3-8402-0b8dffbf29d8",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "934a5689-732b-40e6-843a-0fe1f7b89176",
"Questions": [
{
"Id": "5087a9e5-7199-498c-a63e-6d1287f59fe1",
"Answers": "sample string 2"
},
{
"Id": "5087a9e5-7199-498c-a63e-6d1287f59fe1",
"Answers": "sample string 2"
}
]
},
{
"Id": "934a5689-732b-40e6-843a-0fe1f7b89176",
"Questions": [
{
"Id": "5087a9e5-7199-498c-a63e-6d1287f59fe1",
"Answers": "sample string 2"
},
{
"Id": "5087a9e5-7199-498c-a63e-6d1287f59fe1",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "a74375cc-092a-4eaf-a6bb-500c22251fba",
"ContentItemId": "d1ae39c2-8af9-4df3-8a17-f91334af2edd",
"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-21T07:11:18.6928522+00:00",
"RescheduleDate": "2026-07-21T07:11:18.6928522+00:00"
},
{
"Id": "a74375cc-092a-4eaf-a6bb-500c22251fba",
"ContentItemId": "d1ae39c2-8af9-4df3-8a17-f91334af2edd",
"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-21T07:11:18.6928522+00:00",
"RescheduleDate": "2026-07-21T07:11:18.6928522+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}
text/json
Sample:
{
"UserId": "a56f3db4-6f58-44be-942b-7cdf3328d124",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-07-21T07:11:18.7397276+00:00",
"Registration": {
"Id": "feff4b17-31a4-4a58-8275-363aa6cbb685",
"UserId": "80cc717a-7fae-48c8-a605-887899ffc2e5",
"IsCurrent": true,
"CenterId": "6698786b-aa84-4f02-8808-7b939d81048f",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "5f2839e7-dd30-40bb-9da9-bea2e1aade18",
"EndDate": "2026-07-21T07:11:18.6928522+00:00",
"StartDate": "2026-07-21T07:11:18.6928522+00:00",
"SchedulePreferenceDate": "2026-07-21T07:11:18.6928522+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-21T07:11:18.6928522+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "8a3f3e22-c460-4780-8bc0-e2fde8f19bd6",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "10f50d0f-325b-4415-bc1c-e3b7ef409f9b",
"Sequence": 1,
"AncestorCategoryId": "4c786073-dd07-4c8b-b4fb-814743a21426",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "f8779c39-5ac4-4547-9426-9583e64c0cd8",
"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": "f8779c39-5ac4-4547-9426-9583e64c0cd8",
"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": "8a3f3e22-c460-4780-8bc0-e2fde8f19bd6",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "10f50d0f-325b-4415-bc1c-e3b7ef409f9b",
"Sequence": 1,
"AncestorCategoryId": "4c786073-dd07-4c8b-b4fb-814743a21426",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "f8779c39-5ac4-4547-9426-9583e64c0cd8",
"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": "f8779c39-5ac4-4547-9426-9583e64c0cd8",
"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": "08de2bc1-41cb-4d28-8cc0-a1ec522ffe44",
"CategoryId": "d946abc9-6f88-409d-af67-b59a49c37e25",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "36394236-f715-4ff3-8402-0b8dffbf29d8",
"Score": 1.0,
"State": 1
},
{
"Id": "36394236-f715-4ff3-8402-0b8dffbf29d8",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "934a5689-732b-40e6-843a-0fe1f7b89176",
"Questions": [
{
"Id": "5087a9e5-7199-498c-a63e-6d1287f59fe1",
"Answers": "sample string 2"
},
{
"Id": "5087a9e5-7199-498c-a63e-6d1287f59fe1",
"Answers": "sample string 2"
}
]
},
{
"Id": "934a5689-732b-40e6-843a-0fe1f7b89176",
"Questions": [
{
"Id": "5087a9e5-7199-498c-a63e-6d1287f59fe1",
"Answers": "sample string 2"
},
{
"Id": "5087a9e5-7199-498c-a63e-6d1287f59fe1",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "a74375cc-092a-4eaf-a6bb-500c22251fba",
"ContentItemId": "d1ae39c2-8af9-4df3-8a17-f91334af2edd",
"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-21T07:11:18.6928522+00:00",
"RescheduleDate": "2026-07-21T07:11:18.6928522+00:00"
},
{
"Id": "a74375cc-092a-4eaf-a6bb-500c22251fba",
"ContentItemId": "d1ae39c2-8af9-4df3-8a17-f91334af2edd",
"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-21T07:11:18.6928522+00:00",
"RescheduleDate": "2026-07-21T07:11:18.6928522+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}