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": "3f61f8e5-1476-4b03-9991-1bb703c6d626",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-08-28T09:27:25.6417275+00:00",
"Registration": {
"Id": "d12c6b9b-47b7-4551-b47a-f8c65606a9f8",
"UserId": "722e188d-6000-480f-96ea-9bd3a2571bea",
"IsCurrent": true,
"CenterId": "f3ac1a67-6c31-4002-95a8-0456dc6a8c8d",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "c7c15236-4fa3-4ed2-8667-0c0a2735309f",
"EndDate": "2026-08-28T09:27:25.6417275+00:00",
"StartDate": "2026-08-28T09:27:25.6417275+00:00",
"SchedulePreferenceDate": "2026-08-28T09:27:25.6417275+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-08-28T09:27:25.6417275+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "f397f2fc-5c88-48c9-a8dc-b51c6e79de8e",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "39eb1d3c-e01f-4b3d-b0cd-a69344689a6c",
"Sequence": 1,
"AncestorCategoryId": "28f5e296-e7ba-4bf6-8f49-8b9b3bd3035b",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "88a28d86-e224-479c-90a4-aa868bad74a6",
"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": "88a28d86-e224-479c-90a4-aa868bad74a6",
"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": "f397f2fc-5c88-48c9-a8dc-b51c6e79de8e",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "39eb1d3c-e01f-4b3d-b0cd-a69344689a6c",
"Sequence": 1,
"AncestorCategoryId": "28f5e296-e7ba-4bf6-8f49-8b9b3bd3035b",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "88a28d86-e224-479c-90a4-aa868bad74a6",
"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": "88a28d86-e224-479c-90a4-aa868bad74a6",
"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": "03a53424-10a6-4207-9861-9cabe39a632e",
"CategoryId": "b37704c7-fe7e-41f7-93a3-e0d40c9fe468",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "7c7246f6-d1bb-43e9-81fe-e59ab4d9db35",
"Score": 1.0,
"State": 1
},
{
"Id": "7c7246f6-d1bb-43e9-81fe-e59ab4d9db35",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "c8a70fae-bcc0-4130-9fb7-101f11313c31",
"Questions": [
{
"Id": "cac09fb6-8f5a-47bc-9583-d91ed4f62c62",
"Answers": "sample string 2"
},
{
"Id": "cac09fb6-8f5a-47bc-9583-d91ed4f62c62",
"Answers": "sample string 2"
}
]
},
{
"Id": "c8a70fae-bcc0-4130-9fb7-101f11313c31",
"Questions": [
{
"Id": "cac09fb6-8f5a-47bc-9583-d91ed4f62c62",
"Answers": "sample string 2"
},
{
"Id": "cac09fb6-8f5a-47bc-9583-d91ed4f62c62",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "da0de459-caea-40f9-9a55-2173fdbd1e13",
"ContentItemId": "b622f479-8e08-4e44-882b-fb0947c45597",
"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-08-28T09:27:25.6417275+00:00",
"RescheduleDate": "2026-08-28T09:27:25.6417275+00:00"
},
{
"Id": "da0de459-caea-40f9-9a55-2173fdbd1e13",
"ContentItemId": "b622f479-8e08-4e44-882b-fb0947c45597",
"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-08-28T09:27:25.6417275+00:00",
"RescheduleDate": "2026-08-28T09:27:25.6417275+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}
text/json
Sample:
{
"UserId": "3f61f8e5-1476-4b03-9991-1bb703c6d626",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-08-28T09:27:25.6729767+00:00",
"Registration": {
"Id": "d12c6b9b-47b7-4551-b47a-f8c65606a9f8",
"UserId": "722e188d-6000-480f-96ea-9bd3a2571bea",
"IsCurrent": true,
"CenterId": "f3ac1a67-6c31-4002-95a8-0456dc6a8c8d",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "c7c15236-4fa3-4ed2-8667-0c0a2735309f",
"EndDate": "2026-08-28T09:27:25.6417275+00:00",
"StartDate": "2026-08-28T09:27:25.6417275+00:00",
"SchedulePreferenceDate": "2026-08-28T09:27:25.6417275+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-08-28T09:27:25.6417275+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "f397f2fc-5c88-48c9-a8dc-b51c6e79de8e",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "39eb1d3c-e01f-4b3d-b0cd-a69344689a6c",
"Sequence": 1,
"AncestorCategoryId": "28f5e296-e7ba-4bf6-8f49-8b9b3bd3035b",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "88a28d86-e224-479c-90a4-aa868bad74a6",
"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": "88a28d86-e224-479c-90a4-aa868bad74a6",
"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": "f397f2fc-5c88-48c9-a8dc-b51c6e79de8e",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "39eb1d3c-e01f-4b3d-b0cd-a69344689a6c",
"Sequence": 1,
"AncestorCategoryId": "28f5e296-e7ba-4bf6-8f49-8b9b3bd3035b",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "88a28d86-e224-479c-90a4-aa868bad74a6",
"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": "88a28d86-e224-479c-90a4-aa868bad74a6",
"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": "03a53424-10a6-4207-9861-9cabe39a632e",
"CategoryId": "b37704c7-fe7e-41f7-93a3-e0d40c9fe468",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "7c7246f6-d1bb-43e9-81fe-e59ab4d9db35",
"Score": 1.0,
"State": 1
},
{
"Id": "7c7246f6-d1bb-43e9-81fe-e59ab4d9db35",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "c8a70fae-bcc0-4130-9fb7-101f11313c31",
"Questions": [
{
"Id": "cac09fb6-8f5a-47bc-9583-d91ed4f62c62",
"Answers": "sample string 2"
},
{
"Id": "cac09fb6-8f5a-47bc-9583-d91ed4f62c62",
"Answers": "sample string 2"
}
]
},
{
"Id": "c8a70fae-bcc0-4130-9fb7-101f11313c31",
"Questions": [
{
"Id": "cac09fb6-8f5a-47bc-9583-d91ed4f62c62",
"Answers": "sample string 2"
},
{
"Id": "cac09fb6-8f5a-47bc-9583-d91ed4f62c62",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "da0de459-caea-40f9-9a55-2173fdbd1e13",
"ContentItemId": "b622f479-8e08-4e44-882b-fb0947c45597",
"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-08-28T09:27:25.6417275+00:00",
"RescheduleDate": "2026-08-28T09:27:25.6417275+00:00"
},
{
"Id": "da0de459-caea-40f9-9a55-2173fdbd1e13",
"ContentItemId": "b622f479-8e08-4e44-882b-fb0947c45597",
"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-08-28T09:27:25.6417275+00:00",
"RescheduleDate": "2026-08-28T09:27:25.6417275+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}