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": "110c06e6-db88-4c56-becf-454590b31b4f",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-07-28T20:29:36.4304447+00:00",
"Registration": {
"Id": "73de5ce0-7296-4402-9313-2172deaa6221",
"UserId": "7661e1fd-c761-4e3e-a859-8bc97c8e4a80",
"IsCurrent": true,
"CenterId": "12de5d77-be24-45d8-ae8d-daad354f56db",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "836e8ea7-b692-4ccb-8abb-0af950cf6512",
"EndDate": "2026-07-28T20:29:36.4148219+00:00",
"StartDate": "2026-07-28T20:29:36.4148219+00:00",
"SchedulePreferenceDate": "2026-07-28T20:29:36.4148219+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-28T20:29:36.4148219+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "f387f510-0676-46e7-897d-a5426d631522",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "aaa37438-97e4-4383-a48e-4b033b6e648c",
"Sequence": 1,
"AncestorCategoryId": "23fbd62b-049c-41e1-a8ea-aec5a7318230",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "cacb4351-28e3-46ae-8cea-4098d64f8646",
"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": "cacb4351-28e3-46ae-8cea-4098d64f8646",
"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": "f387f510-0676-46e7-897d-a5426d631522",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "aaa37438-97e4-4383-a48e-4b033b6e648c",
"Sequence": 1,
"AncestorCategoryId": "23fbd62b-049c-41e1-a8ea-aec5a7318230",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "cacb4351-28e3-46ae-8cea-4098d64f8646",
"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": "cacb4351-28e3-46ae-8cea-4098d64f8646",
"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": "518db26e-95ca-47a4-accb-bc9b03c1ae8e",
"CategoryId": "6c2040fa-92e6-4c61-98d8-fb4d9899bdfc",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "7c981aab-e3b0-41be-b70e-6b1e53b2adcd",
"Score": 1.0,
"State": 1
},
{
"Id": "7c981aab-e3b0-41be-b70e-6b1e53b2adcd",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "0226c867-d337-4e0f-9fd5-a2f344024bcd",
"Questions": [
{
"Id": "c472ab4f-060f-4933-8ed0-d00cf62b405b",
"Answers": "sample string 2"
},
{
"Id": "c472ab4f-060f-4933-8ed0-d00cf62b405b",
"Answers": "sample string 2"
}
]
},
{
"Id": "0226c867-d337-4e0f-9fd5-a2f344024bcd",
"Questions": [
{
"Id": "c472ab4f-060f-4933-8ed0-d00cf62b405b",
"Answers": "sample string 2"
},
{
"Id": "c472ab4f-060f-4933-8ed0-d00cf62b405b",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "1c4a2d2b-ccec-4059-96d7-b9b84611b705",
"ContentItemId": "bec55a75-1377-42f0-b44f-fb1a037fec54",
"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-28T20:29:36.4148219+00:00",
"RescheduleDate": "2026-07-28T20:29:36.4148219+00:00"
},
{
"Id": "1c4a2d2b-ccec-4059-96d7-b9b84611b705",
"ContentItemId": "bec55a75-1377-42f0-b44f-fb1a037fec54",
"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-28T20:29:36.4148219+00:00",
"RescheduleDate": "2026-07-28T20:29:36.4148219+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}
text/json
Sample:
{
"UserId": "110c06e6-db88-4c56-becf-454590b31b4f",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-07-28T20:29:36.4616976+00:00",
"Registration": {
"Id": "73de5ce0-7296-4402-9313-2172deaa6221",
"UserId": "7661e1fd-c761-4e3e-a859-8bc97c8e4a80",
"IsCurrent": true,
"CenterId": "12de5d77-be24-45d8-ae8d-daad354f56db",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "836e8ea7-b692-4ccb-8abb-0af950cf6512",
"EndDate": "2026-07-28T20:29:36.4148219+00:00",
"StartDate": "2026-07-28T20:29:36.4148219+00:00",
"SchedulePreferenceDate": "2026-07-28T20:29:36.4148219+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-28T20:29:36.4148219+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "f387f510-0676-46e7-897d-a5426d631522",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "aaa37438-97e4-4383-a48e-4b033b6e648c",
"Sequence": 1,
"AncestorCategoryId": "23fbd62b-049c-41e1-a8ea-aec5a7318230",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "cacb4351-28e3-46ae-8cea-4098d64f8646",
"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": "cacb4351-28e3-46ae-8cea-4098d64f8646",
"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": "f387f510-0676-46e7-897d-a5426d631522",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "aaa37438-97e4-4383-a48e-4b033b6e648c",
"Sequence": 1,
"AncestorCategoryId": "23fbd62b-049c-41e1-a8ea-aec5a7318230",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "cacb4351-28e3-46ae-8cea-4098d64f8646",
"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": "cacb4351-28e3-46ae-8cea-4098d64f8646",
"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": "518db26e-95ca-47a4-accb-bc9b03c1ae8e",
"CategoryId": "6c2040fa-92e6-4c61-98d8-fb4d9899bdfc",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "7c981aab-e3b0-41be-b70e-6b1e53b2adcd",
"Score": 1.0,
"State": 1
},
{
"Id": "7c981aab-e3b0-41be-b70e-6b1e53b2adcd",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "0226c867-d337-4e0f-9fd5-a2f344024bcd",
"Questions": [
{
"Id": "c472ab4f-060f-4933-8ed0-d00cf62b405b",
"Answers": "sample string 2"
},
{
"Id": "c472ab4f-060f-4933-8ed0-d00cf62b405b",
"Answers": "sample string 2"
}
]
},
{
"Id": "0226c867-d337-4e0f-9fd5-a2f344024bcd",
"Questions": [
{
"Id": "c472ab4f-060f-4933-8ed0-d00cf62b405b",
"Answers": "sample string 2"
},
{
"Id": "c472ab4f-060f-4933-8ed0-d00cf62b405b",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "1c4a2d2b-ccec-4059-96d7-b9b84611b705",
"ContentItemId": "bec55a75-1377-42f0-b44f-fb1a037fec54",
"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-28T20:29:36.4148219+00:00",
"RescheduleDate": "2026-07-28T20:29:36.4148219+00:00"
},
{
"Id": "1c4a2d2b-ccec-4059-96d7-b9b84611b705",
"ContentItemId": "bec55a75-1377-42f0-b44f-fb1a037fec54",
"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-28T20:29:36.4148219+00:00",
"RescheduleDate": "2026-07-28T20:29:36.4148219+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}