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": "5d74ad58-0283-4494-a9e0-0ab5b672d79d",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-07-05T03:15:34.0745417+00:00",
"Registration": {
"Id": "ce061fa3-4f09-42e6-b011-5429acc6130c",
"UserId": "f9caaa74-8f59-4371-8e8e-a54ee7c6abf4",
"IsCurrent": true,
"CenterId": "ee0b2fef-909b-4ebe-9fc9-1ae916ff55f2",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "56a0f24e-56e9-4361-9df7-ea5baf88d604",
"EndDate": "2026-07-05T03:15:34.0745417+00:00",
"StartDate": "2026-07-05T03:15:34.0745417+00:00",
"SchedulePreferenceDate": "2026-07-05T03:15:34.0745417+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-05T03:15:34.0745417+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "989ac920-402d-4e80-90e7-342498284f79",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "471d660b-a60b-45a0-acff-d0e69ed13a27",
"Sequence": 1,
"AncestorCategoryId": "e0fe525d-496a-4d24-9847-485daac2ae82",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "ad05490a-9ba1-4373-a3d0-e23a3b6aecbf",
"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": "ad05490a-9ba1-4373-a3d0-e23a3b6aecbf",
"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": "989ac920-402d-4e80-90e7-342498284f79",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "471d660b-a60b-45a0-acff-d0e69ed13a27",
"Sequence": 1,
"AncestorCategoryId": "e0fe525d-496a-4d24-9847-485daac2ae82",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "ad05490a-9ba1-4373-a3d0-e23a3b6aecbf",
"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": "ad05490a-9ba1-4373-a3d0-e23a3b6aecbf",
"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": "5350ace8-3526-41f1-bcc2-077fd52bf689",
"CategoryId": "d82683be-6db7-49fa-9044-13dcf0f9d8dc",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "492b9aad-1c87-4a36-85ee-6979180b8de2",
"Score": 1.0,
"State": 1
},
{
"Id": "492b9aad-1c87-4a36-85ee-6979180b8de2",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "6152304e-4cc4-47ce-b83d-34cf50c55b1a",
"Questions": [
{
"Id": "8e38b242-1ead-44ca-aec4-27a6ba1f4f74",
"Answers": "sample string 2"
},
{
"Id": "8e38b242-1ead-44ca-aec4-27a6ba1f4f74",
"Answers": "sample string 2"
}
]
},
{
"Id": "6152304e-4cc4-47ce-b83d-34cf50c55b1a",
"Questions": [
{
"Id": "8e38b242-1ead-44ca-aec4-27a6ba1f4f74",
"Answers": "sample string 2"
},
{
"Id": "8e38b242-1ead-44ca-aec4-27a6ba1f4f74",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "f31691af-c252-457b-acba-82d77e775a10",
"ContentItemId": "0e1e1d4d-2f96-41c6-a67c-db0427467cd4",
"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-05T03:15:34.0745417+00:00",
"RescheduleDate": "2026-07-05T03:15:34.0745417+00:00"
},
{
"Id": "f31691af-c252-457b-acba-82d77e775a10",
"ContentItemId": "0e1e1d4d-2f96-41c6-a67c-db0427467cd4",
"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-05T03:15:34.0745417+00:00",
"RescheduleDate": "2026-07-05T03:15:34.0745417+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}
text/json
Sample:
{
"UserId": "5d74ad58-0283-4494-a9e0-0ab5b672d79d",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-07-05T03:15:34.1057973+00:00",
"Registration": {
"Id": "ce061fa3-4f09-42e6-b011-5429acc6130c",
"UserId": "f9caaa74-8f59-4371-8e8e-a54ee7c6abf4",
"IsCurrent": true,
"CenterId": "ee0b2fef-909b-4ebe-9fc9-1ae916ff55f2",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "56a0f24e-56e9-4361-9df7-ea5baf88d604",
"EndDate": "2026-07-05T03:15:34.0745417+00:00",
"StartDate": "2026-07-05T03:15:34.0745417+00:00",
"SchedulePreferenceDate": "2026-07-05T03:15:34.0745417+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-05T03:15:34.0745417+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "989ac920-402d-4e80-90e7-342498284f79",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "471d660b-a60b-45a0-acff-d0e69ed13a27",
"Sequence": 1,
"AncestorCategoryId": "e0fe525d-496a-4d24-9847-485daac2ae82",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "ad05490a-9ba1-4373-a3d0-e23a3b6aecbf",
"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": "ad05490a-9ba1-4373-a3d0-e23a3b6aecbf",
"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": "989ac920-402d-4e80-90e7-342498284f79",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "471d660b-a60b-45a0-acff-d0e69ed13a27",
"Sequence": 1,
"AncestorCategoryId": "e0fe525d-496a-4d24-9847-485daac2ae82",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "ad05490a-9ba1-4373-a3d0-e23a3b6aecbf",
"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": "ad05490a-9ba1-4373-a3d0-e23a3b6aecbf",
"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": "5350ace8-3526-41f1-bcc2-077fd52bf689",
"CategoryId": "d82683be-6db7-49fa-9044-13dcf0f9d8dc",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "492b9aad-1c87-4a36-85ee-6979180b8de2",
"Score": 1.0,
"State": 1
},
{
"Id": "492b9aad-1c87-4a36-85ee-6979180b8de2",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "6152304e-4cc4-47ce-b83d-34cf50c55b1a",
"Questions": [
{
"Id": "8e38b242-1ead-44ca-aec4-27a6ba1f4f74",
"Answers": "sample string 2"
},
{
"Id": "8e38b242-1ead-44ca-aec4-27a6ba1f4f74",
"Answers": "sample string 2"
}
]
},
{
"Id": "6152304e-4cc4-47ce-b83d-34cf50c55b1a",
"Questions": [
{
"Id": "8e38b242-1ead-44ca-aec4-27a6ba1f4f74",
"Answers": "sample string 2"
},
{
"Id": "8e38b242-1ead-44ca-aec4-27a6ba1f4f74",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "f31691af-c252-457b-acba-82d77e775a10",
"ContentItemId": "0e1e1d4d-2f96-41c6-a67c-db0427467cd4",
"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-05T03:15:34.0745417+00:00",
"RescheduleDate": "2026-07-05T03:15:34.0745417+00:00"
},
{
"Id": "f31691af-c252-457b-acba-82d77e775a10",
"ContentItemId": "0e1e1d4d-2f96-41c6-a67c-db0427467cd4",
"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-05T03:15:34.0745417+00:00",
"RescheduleDate": "2026-07-05T03:15:34.0745417+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}