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": "8f097831-8a29-498d-bde4-67a2a6ca4feb",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-11-18T07:37:12.3309062+00:00",
"Registration": [
{
"Id": "226c33cc-f2d6-42c8-b303-144c0fb43195",
"UserId": "d1fe29eb-0500-438e-8b3b-8d1c76aff827",
"IsCurrent": true,
"CenterId": "28a287bf-79d4-4804-b672-a865a82d46e7",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "de7e019d-f542-43be-9c8b-8e74c3b4b0da",
"EndDate": "2026-11-18T07:37:12.3309062+00:00",
"StartDate": "2026-11-18T07:37:12.3309062+00:00",
"SchedulePreferenceDate": "2026-11-18T07:37:12.3309062+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": "226c33cc-f2d6-42c8-b303-144c0fb43195",
"UserId": "d1fe29eb-0500-438e-8b3b-8d1c76aff827",
"IsCurrent": true,
"CenterId": "28a287bf-79d4-4804-b672-a865a82d46e7",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "de7e019d-f542-43be-9c8b-8e74c3b4b0da",
"EndDate": "2026-11-18T07:37:12.3309062+00:00",
"StartDate": "2026-11-18T07:37:12.3309062+00:00",
"SchedulePreferenceDate": "2026-11-18T07:37:12.3309062+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-11-18T07:37:12.3309062+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "a8d2e025-d812-462f-a087-aedf711ea75d",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "ff5cd607-0a6e-4382-ac53-55cb93f134e4",
"Sequence": 1,
"AncestorCategoryId": "302cd8ac-3aff-4e20-aa8b-b92acfe8c325",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "b884b707-2d8d-49e2-9fcd-d6ea88e95312",
"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": "b884b707-2d8d-49e2-9fcd-d6ea88e95312",
"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": "a8d2e025-d812-462f-a087-aedf711ea75d",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "ff5cd607-0a6e-4382-ac53-55cb93f134e4",
"Sequence": 1,
"AncestorCategoryId": "302cd8ac-3aff-4e20-aa8b-b92acfe8c325",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "b884b707-2d8d-49e2-9fcd-d6ea88e95312",
"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": "b884b707-2d8d-49e2-9fcd-d6ea88e95312",
"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": "d4b27c8a-5749-46d2-9404-d1e89cf959f3",
"CategoryId": "d3df7456-79ef-4efe-b5ca-9e93954650d5",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "96937712-8307-4637-8c6b-17b52aa8821c",
"Score": 1.0,
"State": 1
},
{
"Id": "96937712-8307-4637-8c6b-17b52aa8821c",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "57d53848-a732-48c3-9fce-251d5726f47e",
"Questions": [
{
"Id": "c6649bda-7af5-45eb-a018-e6e6b57015fc",
"Answers": "sample string 2"
},
{
"Id": "c6649bda-7af5-45eb-a018-e6e6b57015fc",
"Answers": "sample string 2"
}
]
},
{
"Id": "57d53848-a732-48c3-9fce-251d5726f47e",
"Questions": [
{
"Id": "c6649bda-7af5-45eb-a018-e6e6b57015fc",
"Answers": "sample string 2"
},
{
"Id": "c6649bda-7af5-45eb-a018-e6e6b57015fc",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "0a2a630a-e5b4-4bb1-863c-2b343620069b",
"ContentItemId": "fe479b6a-f6ad-42d0-b366-2ee246f7492e",
"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-11-18T07:37:12.3309062+00:00",
"RescheduleDate": "2026-11-18T07:37:12.3309062+00:00"
},
{
"Id": "0a2a630a-e5b4-4bb1-863c-2b343620069b",
"ContentItemId": "fe479b6a-f6ad-42d0-b366-2ee246f7492e",
"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-11-18T07:37:12.3309062+00:00",
"RescheduleDate": "2026-11-18T07:37:12.3309062+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": "8f097831-8a29-498d-bde4-67a2a6ca4feb",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-11-18T07:37:12.3777832+00:00",
"Registration": [
{
"Id": "226c33cc-f2d6-42c8-b303-144c0fb43195",
"UserId": "d1fe29eb-0500-438e-8b3b-8d1c76aff827",
"IsCurrent": true,
"CenterId": "28a287bf-79d4-4804-b672-a865a82d46e7",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "de7e019d-f542-43be-9c8b-8e74c3b4b0da",
"EndDate": "2026-11-18T07:37:12.3309062+00:00",
"StartDate": "2026-11-18T07:37:12.3309062+00:00",
"SchedulePreferenceDate": "2026-11-18T07:37:12.3309062+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": "226c33cc-f2d6-42c8-b303-144c0fb43195",
"UserId": "d1fe29eb-0500-438e-8b3b-8d1c76aff827",
"IsCurrent": true,
"CenterId": "28a287bf-79d4-4804-b672-a865a82d46e7",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "de7e019d-f542-43be-9c8b-8e74c3b4b0da",
"EndDate": "2026-11-18T07:37:12.3309062+00:00",
"StartDate": "2026-11-18T07:37:12.3309062+00:00",
"SchedulePreferenceDate": "2026-11-18T07:37:12.3309062+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-11-18T07:37:12.3309062+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "a8d2e025-d812-462f-a087-aedf711ea75d",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "ff5cd607-0a6e-4382-ac53-55cb93f134e4",
"Sequence": 1,
"AncestorCategoryId": "302cd8ac-3aff-4e20-aa8b-b92acfe8c325",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "b884b707-2d8d-49e2-9fcd-d6ea88e95312",
"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": "b884b707-2d8d-49e2-9fcd-d6ea88e95312",
"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": "a8d2e025-d812-462f-a087-aedf711ea75d",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "ff5cd607-0a6e-4382-ac53-55cb93f134e4",
"Sequence": 1,
"AncestorCategoryId": "302cd8ac-3aff-4e20-aa8b-b92acfe8c325",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "b884b707-2d8d-49e2-9fcd-d6ea88e95312",
"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": "b884b707-2d8d-49e2-9fcd-d6ea88e95312",
"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": "d4b27c8a-5749-46d2-9404-d1e89cf959f3",
"CategoryId": "d3df7456-79ef-4efe-b5ca-9e93954650d5",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "96937712-8307-4637-8c6b-17b52aa8821c",
"Score": 1.0,
"State": 1
},
{
"Id": "96937712-8307-4637-8c6b-17b52aa8821c",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "57d53848-a732-48c3-9fce-251d5726f47e",
"Questions": [
{
"Id": "c6649bda-7af5-45eb-a018-e6e6b57015fc",
"Answers": "sample string 2"
},
{
"Id": "c6649bda-7af5-45eb-a018-e6e6b57015fc",
"Answers": "sample string 2"
}
]
},
{
"Id": "57d53848-a732-48c3-9fce-251d5726f47e",
"Questions": [
{
"Id": "c6649bda-7af5-45eb-a018-e6e6b57015fc",
"Answers": "sample string 2"
},
{
"Id": "c6649bda-7af5-45eb-a018-e6e6b57015fc",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "0a2a630a-e5b4-4bb1-863c-2b343620069b",
"ContentItemId": "fe479b6a-f6ad-42d0-b366-2ee246f7492e",
"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-11-18T07:37:12.3309062+00:00",
"RescheduleDate": "2026-11-18T07:37:12.3309062+00:00"
},
{
"Id": "0a2a630a-e5b4-4bb1-863c-2b343620069b",
"ContentItemId": "fe479b6a-f6ad-42d0-b366-2ee246f7492e",
"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-11-18T07:37:12.3309062+00:00",
"RescheduleDate": "2026-11-18T07:37:12.3309062+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
},
"StudentSpeakPlusLevelInfo": "sample string 5"
}