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": "827eb26c-4645-47b5-be95-f4f0357089cd",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-02-12T23:28:42.9030163+00:00",
"Registration": [
{
"Id": "19790664-78f8-4103-8784-4e58dfe949ce",
"UserId": "851e8e03-6115-4e4a-a408-644c90594af0",
"IsCurrent": true,
"CenterId": "f6987296-0d28-4525-9269-6d8f698564fc",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "007f6b00-c7f9-46f4-89d2-2bf66e5eca4e",
"EndDate": "2026-02-12T23:28:42.9030163+00:00",
"StartDate": "2026-02-12T23:28:42.9030163+00:00",
"SchedulePreferenceDate": "2026-02-12T23:28:42.9030163+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": "19790664-78f8-4103-8784-4e58dfe949ce",
"UserId": "851e8e03-6115-4e4a-a408-644c90594af0",
"IsCurrent": true,
"CenterId": "f6987296-0d28-4525-9269-6d8f698564fc",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "007f6b00-c7f9-46f4-89d2-2bf66e5eca4e",
"EndDate": "2026-02-12T23:28:42.9030163+00:00",
"StartDate": "2026-02-12T23:28:42.9030163+00:00",
"SchedulePreferenceDate": "2026-02-12T23:28:42.9030163+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-02-12T23:28:42.9030163+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "274e51f6-ac18-4a45-87ad-5cbb8fb7d9ed",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "30ab3eef-33bb-4d2d-a9df-7185348d3f1e",
"Sequence": 1,
"AncestorCategoryId": "056b060f-d3b1-47d9-9b05-d5e0d1972755",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "53a592b4-ece8-4eef-bf75-b496e873e5ca",
"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": "53a592b4-ece8-4eef-bf75-b496e873e5ca",
"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": "274e51f6-ac18-4a45-87ad-5cbb8fb7d9ed",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "30ab3eef-33bb-4d2d-a9df-7185348d3f1e",
"Sequence": 1,
"AncestorCategoryId": "056b060f-d3b1-47d9-9b05-d5e0d1972755",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "53a592b4-ece8-4eef-bf75-b496e873e5ca",
"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": "53a592b4-ece8-4eef-bf75-b496e873e5ca",
"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": "d39dcf3f-bbd5-4622-89cf-8efb3e5bc308",
"CategoryId": "74d0db94-7ec6-4481-a051-925aadbe2558",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "2daf090b-7ae6-41a3-a0a4-38f02513ba99",
"Score": 1.0,
"State": 1
},
{
"Id": "2daf090b-7ae6-41a3-a0a4-38f02513ba99",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "6e6682fc-d5cd-416e-b57c-40762f2b2fb2",
"Questions": [
{
"Id": "c2710da7-f62f-44fe-9c44-1d0f86e36c73",
"Answers": "sample string 2"
},
{
"Id": "c2710da7-f62f-44fe-9c44-1d0f86e36c73",
"Answers": "sample string 2"
}
]
},
{
"Id": "6e6682fc-d5cd-416e-b57c-40762f2b2fb2",
"Questions": [
{
"Id": "c2710da7-f62f-44fe-9c44-1d0f86e36c73",
"Answers": "sample string 2"
},
{
"Id": "c2710da7-f62f-44fe-9c44-1d0f86e36c73",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "988a5384-9637-4b4a-88fa-327f242c8d67",
"ContentItemId": "ce4b3689-b394-4eba-943c-e8f14fdec1a1",
"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-02-12T23:28:42.9030163+00:00",
"RescheduleDate": "2026-02-12T23:28:42.9030163+00:00"
},
{
"Id": "988a5384-9637-4b4a-88fa-327f242c8d67",
"ContentItemId": "ce4b3689-b394-4eba-943c-e8f14fdec1a1",
"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-02-12T23:28:42.9030163+00:00",
"RescheduleDate": "2026-02-12T23:28:42.9030163+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": "827eb26c-4645-47b5-be95-f4f0357089cd",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-02-12T23:28:42.9342646+00:00",
"Registration": [
{
"Id": "19790664-78f8-4103-8784-4e58dfe949ce",
"UserId": "851e8e03-6115-4e4a-a408-644c90594af0",
"IsCurrent": true,
"CenterId": "f6987296-0d28-4525-9269-6d8f698564fc",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "007f6b00-c7f9-46f4-89d2-2bf66e5eca4e",
"EndDate": "2026-02-12T23:28:42.9030163+00:00",
"StartDate": "2026-02-12T23:28:42.9030163+00:00",
"SchedulePreferenceDate": "2026-02-12T23:28:42.9030163+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": "19790664-78f8-4103-8784-4e58dfe949ce",
"UserId": "851e8e03-6115-4e4a-a408-644c90594af0",
"IsCurrent": true,
"CenterId": "f6987296-0d28-4525-9269-6d8f698564fc",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "007f6b00-c7f9-46f4-89d2-2bf66e5eca4e",
"EndDate": "2026-02-12T23:28:42.9030163+00:00",
"StartDate": "2026-02-12T23:28:42.9030163+00:00",
"SchedulePreferenceDate": "2026-02-12T23:28:42.9030163+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-02-12T23:28:42.9030163+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "274e51f6-ac18-4a45-87ad-5cbb8fb7d9ed",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "30ab3eef-33bb-4d2d-a9df-7185348d3f1e",
"Sequence": 1,
"AncestorCategoryId": "056b060f-d3b1-47d9-9b05-d5e0d1972755",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "53a592b4-ece8-4eef-bf75-b496e873e5ca",
"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": "53a592b4-ece8-4eef-bf75-b496e873e5ca",
"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": "274e51f6-ac18-4a45-87ad-5cbb8fb7d9ed",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "30ab3eef-33bb-4d2d-a9df-7185348d3f1e",
"Sequence": 1,
"AncestorCategoryId": "056b060f-d3b1-47d9-9b05-d5e0d1972755",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "53a592b4-ece8-4eef-bf75-b496e873e5ca",
"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": "53a592b4-ece8-4eef-bf75-b496e873e5ca",
"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": "d39dcf3f-bbd5-4622-89cf-8efb3e5bc308",
"CategoryId": "74d0db94-7ec6-4481-a051-925aadbe2558",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "2daf090b-7ae6-41a3-a0a4-38f02513ba99",
"Score": 1.0,
"State": 1
},
{
"Id": "2daf090b-7ae6-41a3-a0a4-38f02513ba99",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "6e6682fc-d5cd-416e-b57c-40762f2b2fb2",
"Questions": [
{
"Id": "c2710da7-f62f-44fe-9c44-1d0f86e36c73",
"Answers": "sample string 2"
},
{
"Id": "c2710da7-f62f-44fe-9c44-1d0f86e36c73",
"Answers": "sample string 2"
}
]
},
{
"Id": "6e6682fc-d5cd-416e-b57c-40762f2b2fb2",
"Questions": [
{
"Id": "c2710da7-f62f-44fe-9c44-1d0f86e36c73",
"Answers": "sample string 2"
},
{
"Id": "c2710da7-f62f-44fe-9c44-1d0f86e36c73",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "988a5384-9637-4b4a-88fa-327f242c8d67",
"ContentItemId": "ce4b3689-b394-4eba-943c-e8f14fdec1a1",
"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-02-12T23:28:42.9030163+00:00",
"RescheduleDate": "2026-02-12T23:28:42.9030163+00:00"
},
{
"Id": "988a5384-9637-4b4a-88fa-327f242c8d67",
"ContentItemId": "ce4b3689-b394-4eba-943c-e8f14fdec1a1",
"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-02-12T23:28:42.9030163+00:00",
"RescheduleDate": "2026-02-12T23:28:42.9030163+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
},
"StudentSpeakPlusLevelInfo": "sample string 5"
}