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": "b07c69d0-2d74-463c-8f20-475c80a255c5",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-11-13T08:19:52.7682668+00:00",
"Registration": [
{
"Id": "f68cbe85-961c-4b57-a4da-58569805fc31",
"UserId": "625d5f93-682c-4b70-9677-db22bbf1daaf",
"IsCurrent": true,
"CenterId": "159ee49b-acd5-48d3-b230-771b76005294",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "144f24a2-9ee9-41fb-b250-658ca2b1ef44",
"EndDate": "2026-11-13T08:19:52.7526495+00:00",
"StartDate": "2026-11-13T08:19:52.7526495+00:00",
"SchedulePreferenceDate": "2026-11-13T08:19:52.7526495+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": "f68cbe85-961c-4b57-a4da-58569805fc31",
"UserId": "625d5f93-682c-4b70-9677-db22bbf1daaf",
"IsCurrent": true,
"CenterId": "159ee49b-acd5-48d3-b230-771b76005294",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "144f24a2-9ee9-41fb-b250-658ca2b1ef44",
"EndDate": "2026-11-13T08:19:52.7526495+00:00",
"StartDate": "2026-11-13T08:19:52.7526495+00:00",
"SchedulePreferenceDate": "2026-11-13T08:19:52.7526495+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-13T08:19:52.7526495+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "62265ec4-be78-4b7f-a151-dfd7e41c7dfd",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "743e4563-e8ad-4619-944b-e0109e72c5b2",
"Sequence": 1,
"AncestorCategoryId": "fd82bc7c-0427-4a72-aced-8abff5c79c82",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "53fc4b8b-09b1-4eca-8bc1-42136787eded",
"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": "53fc4b8b-09b1-4eca-8bc1-42136787eded",
"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": "62265ec4-be78-4b7f-a151-dfd7e41c7dfd",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "743e4563-e8ad-4619-944b-e0109e72c5b2",
"Sequence": 1,
"AncestorCategoryId": "fd82bc7c-0427-4a72-aced-8abff5c79c82",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "53fc4b8b-09b1-4eca-8bc1-42136787eded",
"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": "53fc4b8b-09b1-4eca-8bc1-42136787eded",
"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": "f22dc71d-6e98-4a24-b923-07d76663c142",
"CategoryId": "ee9ebdaf-9ab4-4f18-b92a-e7738c1430fc",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "bf68e4bd-f7ba-4cbd-8370-f09cf5b1b0ef",
"Score": 1.0,
"State": 1
},
{
"Id": "bf68e4bd-f7ba-4cbd-8370-f09cf5b1b0ef",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "c0556538-4f37-4207-8007-f74b1f08342f",
"Questions": [
{
"Id": "8c003193-417b-493e-9418-58acc53c44ae",
"Answers": "sample string 2"
},
{
"Id": "8c003193-417b-493e-9418-58acc53c44ae",
"Answers": "sample string 2"
}
]
},
{
"Id": "c0556538-4f37-4207-8007-f74b1f08342f",
"Questions": [
{
"Id": "8c003193-417b-493e-9418-58acc53c44ae",
"Answers": "sample string 2"
},
{
"Id": "8c003193-417b-493e-9418-58acc53c44ae",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "f7ee0e2c-96db-47c2-b345-eb5f605fce22",
"ContentItemId": "624bf19f-d6c3-4210-b8e2-ecab5321a660",
"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-13T08:19:52.7682668+00:00",
"RescheduleDate": "2026-11-13T08:19:52.7682668+00:00"
},
{
"Id": "f7ee0e2c-96db-47c2-b345-eb5f605fce22",
"ContentItemId": "624bf19f-d6c3-4210-b8e2-ecab5321a660",
"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-13T08:19:52.7682668+00:00",
"RescheduleDate": "2026-11-13T08:19:52.7682668+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": "b07c69d0-2d74-463c-8f20-475c80a255c5",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-11-13T08:19:52.799516+00:00",
"Registration": [
{
"Id": "f68cbe85-961c-4b57-a4da-58569805fc31",
"UserId": "625d5f93-682c-4b70-9677-db22bbf1daaf",
"IsCurrent": true,
"CenterId": "159ee49b-acd5-48d3-b230-771b76005294",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "144f24a2-9ee9-41fb-b250-658ca2b1ef44",
"EndDate": "2026-11-13T08:19:52.7526495+00:00",
"StartDate": "2026-11-13T08:19:52.7526495+00:00",
"SchedulePreferenceDate": "2026-11-13T08:19:52.7526495+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": "f68cbe85-961c-4b57-a4da-58569805fc31",
"UserId": "625d5f93-682c-4b70-9677-db22bbf1daaf",
"IsCurrent": true,
"CenterId": "159ee49b-acd5-48d3-b230-771b76005294",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "144f24a2-9ee9-41fb-b250-658ca2b1ef44",
"EndDate": "2026-11-13T08:19:52.7526495+00:00",
"StartDate": "2026-11-13T08:19:52.7526495+00:00",
"SchedulePreferenceDate": "2026-11-13T08:19:52.7526495+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-13T08:19:52.7526495+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "62265ec4-be78-4b7f-a151-dfd7e41c7dfd",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "743e4563-e8ad-4619-944b-e0109e72c5b2",
"Sequence": 1,
"AncestorCategoryId": "fd82bc7c-0427-4a72-aced-8abff5c79c82",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "53fc4b8b-09b1-4eca-8bc1-42136787eded",
"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": "53fc4b8b-09b1-4eca-8bc1-42136787eded",
"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": "62265ec4-be78-4b7f-a151-dfd7e41c7dfd",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "743e4563-e8ad-4619-944b-e0109e72c5b2",
"Sequence": 1,
"AncestorCategoryId": "fd82bc7c-0427-4a72-aced-8abff5c79c82",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "53fc4b8b-09b1-4eca-8bc1-42136787eded",
"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": "53fc4b8b-09b1-4eca-8bc1-42136787eded",
"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": "f22dc71d-6e98-4a24-b923-07d76663c142",
"CategoryId": "ee9ebdaf-9ab4-4f18-b92a-e7738c1430fc",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "bf68e4bd-f7ba-4cbd-8370-f09cf5b1b0ef",
"Score": 1.0,
"State": 1
},
{
"Id": "bf68e4bd-f7ba-4cbd-8370-f09cf5b1b0ef",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "c0556538-4f37-4207-8007-f74b1f08342f",
"Questions": [
{
"Id": "8c003193-417b-493e-9418-58acc53c44ae",
"Answers": "sample string 2"
},
{
"Id": "8c003193-417b-493e-9418-58acc53c44ae",
"Answers": "sample string 2"
}
]
},
{
"Id": "c0556538-4f37-4207-8007-f74b1f08342f",
"Questions": [
{
"Id": "8c003193-417b-493e-9418-58acc53c44ae",
"Answers": "sample string 2"
},
{
"Id": "8c003193-417b-493e-9418-58acc53c44ae",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "f7ee0e2c-96db-47c2-b345-eb5f605fce22",
"ContentItemId": "624bf19f-d6c3-4210-b8e2-ecab5321a660",
"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-13T08:19:52.7682668+00:00",
"RescheduleDate": "2026-11-13T08:19:52.7682668+00:00"
},
{
"Id": "f7ee0e2c-96db-47c2-b345-eb5f605fce22",
"ContentItemId": "624bf19f-d6c3-4210-b8e2-ecab5321a660",
"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-13T08:19:52.7682668+00:00",
"RescheduleDate": "2026-11-13T08:19:52.7682668+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
},
"StudentSpeakPlusLevelInfo": "sample string 5"
}