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": "b1e619e3-2a46-441a-b607-6596678e5333",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-06-11T06:28:39.1379236+00:00",
"Registration": {
"Id": "4b2b5d7e-e89a-408f-8de2-52affe7d9cbe",
"UserId": "7ae529be-dcdf-4616-85ad-cb903db9ea1b",
"IsCurrent": true,
"CenterId": "932c1d1c-ae47-4fbd-9b31-23e511cb439c",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "040c9f15-3b6f-4d6e-b9a1-4fff53031ce1",
"EndDate": "2026-06-11T06:28:39.1222915+00:00",
"StartDate": "2026-06-11T06:28:39.1222915+00:00",
"SchedulePreferenceDate": "2026-06-11T06:28:39.1222915+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-06-11T06:28:39.1222915+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "5e117a96-fc55-4919-9c1e-cf07fab4e517",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "0a4e17ce-a58b-4c1f-804f-f78854ef4946",
"Sequence": 1,
"AncestorCategoryId": "51623441-6165-4c5e-9bce-ff7efd7ac633",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "5e328400-30ae-4a46-b740-9208e962efe0",
"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": "5e328400-30ae-4a46-b740-9208e962efe0",
"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": "5e117a96-fc55-4919-9c1e-cf07fab4e517",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "0a4e17ce-a58b-4c1f-804f-f78854ef4946",
"Sequence": 1,
"AncestorCategoryId": "51623441-6165-4c5e-9bce-ff7efd7ac633",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "5e328400-30ae-4a46-b740-9208e962efe0",
"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": "5e328400-30ae-4a46-b740-9208e962efe0",
"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": "f1cedf71-f52f-49a3-8727-d1027aabd5e3",
"CategoryId": "20307353-df05-4fa7-92c2-6f74c9283dcf",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "ddb905cd-dbad-4cec-834d-349a5fa4c8de",
"Score": 1.0,
"State": 1
},
{
"Id": "ddb905cd-dbad-4cec-834d-349a5fa4c8de",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "45f85778-0e12-4bc3-bdc1-6fcd0d165d5f",
"Questions": [
{
"Id": "b290e169-f8d3-4d81-8dac-0a898530cc19",
"Answers": "sample string 2"
},
{
"Id": "b290e169-f8d3-4d81-8dac-0a898530cc19",
"Answers": "sample string 2"
}
]
},
{
"Id": "45f85778-0e12-4bc3-bdc1-6fcd0d165d5f",
"Questions": [
{
"Id": "b290e169-f8d3-4d81-8dac-0a898530cc19",
"Answers": "sample string 2"
},
{
"Id": "b290e169-f8d3-4d81-8dac-0a898530cc19",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "e917b17e-f170-48dc-b979-67a78db08450",
"ContentItemId": "6c7c741f-4bb9-4f00-878f-b6ec951e33f3",
"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-06-11T06:28:39.1222915+00:00",
"RescheduleDate": "2026-06-11T06:28:39.1222915+00:00"
},
{
"Id": "e917b17e-f170-48dc-b979-67a78db08450",
"ContentItemId": "6c7c741f-4bb9-4f00-878f-b6ec951e33f3",
"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-06-11T06:28:39.1222915+00:00",
"RescheduleDate": "2026-06-11T06:28:39.1222915+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}
text/json
Sample:
{
"UserId": "b1e619e3-2a46-441a-b607-6596678e5333",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-06-11T06:28:39.1691668+00:00",
"Registration": {
"Id": "4b2b5d7e-e89a-408f-8de2-52affe7d9cbe",
"UserId": "7ae529be-dcdf-4616-85ad-cb903db9ea1b",
"IsCurrent": true,
"CenterId": "932c1d1c-ae47-4fbd-9b31-23e511cb439c",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "040c9f15-3b6f-4d6e-b9a1-4fff53031ce1",
"EndDate": "2026-06-11T06:28:39.1222915+00:00",
"StartDate": "2026-06-11T06:28:39.1222915+00:00",
"SchedulePreferenceDate": "2026-06-11T06:28:39.1222915+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-06-11T06:28:39.1222915+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "5e117a96-fc55-4919-9c1e-cf07fab4e517",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "0a4e17ce-a58b-4c1f-804f-f78854ef4946",
"Sequence": 1,
"AncestorCategoryId": "51623441-6165-4c5e-9bce-ff7efd7ac633",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "5e328400-30ae-4a46-b740-9208e962efe0",
"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": "5e328400-30ae-4a46-b740-9208e962efe0",
"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": "5e117a96-fc55-4919-9c1e-cf07fab4e517",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "0a4e17ce-a58b-4c1f-804f-f78854ef4946",
"Sequence": 1,
"AncestorCategoryId": "51623441-6165-4c5e-9bce-ff7efd7ac633",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "5e328400-30ae-4a46-b740-9208e962efe0",
"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": "5e328400-30ae-4a46-b740-9208e962efe0",
"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": "f1cedf71-f52f-49a3-8727-d1027aabd5e3",
"CategoryId": "20307353-df05-4fa7-92c2-6f74c9283dcf",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "ddb905cd-dbad-4cec-834d-349a5fa4c8de",
"Score": 1.0,
"State": 1
},
{
"Id": "ddb905cd-dbad-4cec-834d-349a5fa4c8de",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "45f85778-0e12-4bc3-bdc1-6fcd0d165d5f",
"Questions": [
{
"Id": "b290e169-f8d3-4d81-8dac-0a898530cc19",
"Answers": "sample string 2"
},
{
"Id": "b290e169-f8d3-4d81-8dac-0a898530cc19",
"Answers": "sample string 2"
}
]
},
{
"Id": "45f85778-0e12-4bc3-bdc1-6fcd0d165d5f",
"Questions": [
{
"Id": "b290e169-f8d3-4d81-8dac-0a898530cc19",
"Answers": "sample string 2"
},
{
"Id": "b290e169-f8d3-4d81-8dac-0a898530cc19",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "e917b17e-f170-48dc-b979-67a78db08450",
"ContentItemId": "6c7c741f-4bb9-4f00-878f-b6ec951e33f3",
"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-06-11T06:28:39.1222915+00:00",
"RescheduleDate": "2026-06-11T06:28:39.1222915+00:00"
},
{
"Id": "e917b17e-f170-48dc-b979-67a78db08450",
"ContentItemId": "6c7c741f-4bb9-4f00-878f-b6ec951e33f3",
"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-06-11T06:28:39.1222915+00:00",
"RescheduleDate": "2026-06-11T06:28:39.1222915+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}