GET v2/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.View.UserStateViewModelResponse Formats
application/json
Sample:
{
"UserId": "71cab764-a13e-48f6-8d8b-3bd307990b79",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-01-27T02:11:24.6436861+00:00",
"Registration": [
{
"Id": "088d9c6f-ec00-47d2-81f9-b62260b8b1b7",
"UserId": "bc580d74-e247-43eb-9d12-09eb4e671090",
"IsCurrent": true,
"CenterId": "3cbdf510-fe14-4a2f-b35a-3eb97bc72d1a",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "13c91fa7-410c-44be-992c-9f91243ef19c",
"EndDate": "2026-01-27T02:11:24.6436861+00:00",
"StartDate": "2026-01-27T02:11:24.6436861+00:00",
"SchedulePreferenceDate": "2026-01-27T02:11:24.6436861+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"
},
{
"Id": "088d9c6f-ec00-47d2-81f9-b62260b8b1b7",
"UserId": "bc580d74-e247-43eb-9d12-09eb4e671090",
"IsCurrent": true,
"CenterId": "3cbdf510-fe14-4a2f-b35a-3eb97bc72d1a",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "13c91fa7-410c-44be-992c-9f91243ef19c",
"EndDate": "2026-01-27T02:11:24.6436861+00:00",
"StartDate": "2026-01-27T02:11:24.6436861+00:00",
"SchedulePreferenceDate": "2026-01-27T02:11:24.6436861+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-01-27T02:11:24.6436861+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "101032ae-aa83-4e38-bc43-222daac1642a",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "80390c0e-9196-4c22-8a30-8e796d8e6592",
"Sequence": 1,
"AncestorCategoryId": "aa72c932-0497-467f-b815-0ebe107dd3a1",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "dd665506-65a4-4279-b1d2-141a936a9f8d",
"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": "dd665506-65a4-4279-b1d2-141a936a9f8d",
"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": "101032ae-aa83-4e38-bc43-222daac1642a",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "80390c0e-9196-4c22-8a30-8e796d8e6592",
"Sequence": 1,
"AncestorCategoryId": "aa72c932-0497-467f-b815-0ebe107dd3a1",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "dd665506-65a4-4279-b1d2-141a936a9f8d",
"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": "dd665506-65a4-4279-b1d2-141a936a9f8d",
"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": "b14695d5-8688-481e-9c6b-c9bf9e76eeac",
"CategoryId": "252d6a43-966e-4298-b605-eefdbef276b2",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "55d0a7c3-95eb-4f65-8220-b8f902af46b9",
"Score": 1.0,
"State": 1
},
{
"Id": "55d0a7c3-95eb-4f65-8220-b8f902af46b9",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "e775d4ff-7c0f-4257-a623-16a867cc0ba2",
"Questions": [
{
"Id": "54e7dbf9-35e9-472d-a003-98c34189a102",
"Answers": "sample string 2"
},
{
"Id": "54e7dbf9-35e9-472d-a003-98c34189a102",
"Answers": "sample string 2"
}
]
},
{
"Id": "e775d4ff-7c0f-4257-a623-16a867cc0ba2",
"Questions": [
{
"Id": "54e7dbf9-35e9-472d-a003-98c34189a102",
"Answers": "sample string 2"
},
{
"Id": "54e7dbf9-35e9-472d-a003-98c34189a102",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "f01fad57-1f06-4686-bd35-e3a108fd637b",
"ContentItemId": "2cdff194-1310-4f91-bc48-281cd12817b1",
"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-01-27T02:11:24.6436861+00:00",
"RescheduleDate": "2026-01-27T02:11:24.6436861+00:00"
},
{
"Id": "f01fad57-1f06-4686-bd35-e3a108fd637b",
"ContentItemId": "2cdff194-1310-4f91-bc48-281cd12817b1",
"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-01-27T02:11:24.6436861+00:00",
"RescheduleDate": "2026-01-27T02:11:24.6436861+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
},
"StudentSpeakPlusLevelInfo": "sample string 5"
}
text/json
Sample:
{
"UserId": "71cab764-a13e-48f6-8d8b-3bd307990b79",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-01-27T02:11:24.6905073+00:00",
"Registration": [
{
"Id": "088d9c6f-ec00-47d2-81f9-b62260b8b1b7",
"UserId": "bc580d74-e247-43eb-9d12-09eb4e671090",
"IsCurrent": true,
"CenterId": "3cbdf510-fe14-4a2f-b35a-3eb97bc72d1a",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "13c91fa7-410c-44be-992c-9f91243ef19c",
"EndDate": "2026-01-27T02:11:24.6436861+00:00",
"StartDate": "2026-01-27T02:11:24.6436861+00:00",
"SchedulePreferenceDate": "2026-01-27T02:11:24.6436861+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"
},
{
"Id": "088d9c6f-ec00-47d2-81f9-b62260b8b1b7",
"UserId": "bc580d74-e247-43eb-9d12-09eb4e671090",
"IsCurrent": true,
"CenterId": "3cbdf510-fe14-4a2f-b35a-3eb97bc72d1a",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "13c91fa7-410c-44be-992c-9f91243ef19c",
"EndDate": "2026-01-27T02:11:24.6436861+00:00",
"StartDate": "2026-01-27T02:11:24.6436861+00:00",
"SchedulePreferenceDate": "2026-01-27T02:11:24.6436861+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-01-27T02:11:24.6436861+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "101032ae-aa83-4e38-bc43-222daac1642a",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "80390c0e-9196-4c22-8a30-8e796d8e6592",
"Sequence": 1,
"AncestorCategoryId": "aa72c932-0497-467f-b815-0ebe107dd3a1",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "dd665506-65a4-4279-b1d2-141a936a9f8d",
"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": "dd665506-65a4-4279-b1d2-141a936a9f8d",
"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": "101032ae-aa83-4e38-bc43-222daac1642a",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "80390c0e-9196-4c22-8a30-8e796d8e6592",
"Sequence": 1,
"AncestorCategoryId": "aa72c932-0497-467f-b815-0ebe107dd3a1",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "dd665506-65a4-4279-b1d2-141a936a9f8d",
"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": "dd665506-65a4-4279-b1d2-141a936a9f8d",
"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": "b14695d5-8688-481e-9c6b-c9bf9e76eeac",
"CategoryId": "252d6a43-966e-4298-b605-eefdbef276b2",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "55d0a7c3-95eb-4f65-8220-b8f902af46b9",
"Score": 1.0,
"State": 1
},
{
"Id": "55d0a7c3-95eb-4f65-8220-b8f902af46b9",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "e775d4ff-7c0f-4257-a623-16a867cc0ba2",
"Questions": [
{
"Id": "54e7dbf9-35e9-472d-a003-98c34189a102",
"Answers": "sample string 2"
},
{
"Id": "54e7dbf9-35e9-472d-a003-98c34189a102",
"Answers": "sample string 2"
}
]
},
{
"Id": "e775d4ff-7c0f-4257-a623-16a867cc0ba2",
"Questions": [
{
"Id": "54e7dbf9-35e9-472d-a003-98c34189a102",
"Answers": "sample string 2"
},
{
"Id": "54e7dbf9-35e9-472d-a003-98c34189a102",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "f01fad57-1f06-4686-bd35-e3a108fd637b",
"ContentItemId": "2cdff194-1310-4f91-bc48-281cd12817b1",
"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-01-27T02:11:24.6436861+00:00",
"RescheduleDate": "2026-01-27T02:11:24.6436861+00:00"
},
{
"Id": "f01fad57-1f06-4686-bd35-e3a108fd637b",
"ContentItemId": "2cdff194-1310-4f91-bc48-281cd12817b1",
"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-01-27T02:11:24.6436861+00:00",
"RescheduleDate": "2026-01-27T02:11:24.6436861+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
},
"StudentSpeakPlusLevelInfo": "sample string 5"
}