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": "cc12c024-6d62-4224-b5c2-ae3b2275d772",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-04-22T10:45:51.7612898+00:00",
"Registration": [
{
"Id": "6ed9bf18-3b14-44b4-8963-bfbcf0bf68b1",
"UserId": "5274dd47-5939-45d7-8566-9614525ada0d",
"IsCurrent": true,
"CenterId": "991a71d5-00fe-419d-a27b-1610bce97037",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "dd60397b-ce3c-4193-8c82-3cf583893a35",
"EndDate": "2026-04-22T10:45:51.7612898+00:00",
"StartDate": "2026-04-22T10:45:51.7612898+00:00",
"SchedulePreferenceDate": "2026-04-22T10:45:51.7612898+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": "6ed9bf18-3b14-44b4-8963-bfbcf0bf68b1",
"UserId": "5274dd47-5939-45d7-8566-9614525ada0d",
"IsCurrent": true,
"CenterId": "991a71d5-00fe-419d-a27b-1610bce97037",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "dd60397b-ce3c-4193-8c82-3cf583893a35",
"EndDate": "2026-04-22T10:45:51.7612898+00:00",
"StartDate": "2026-04-22T10:45:51.7612898+00:00",
"SchedulePreferenceDate": "2026-04-22T10:45:51.7612898+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-04-22T10:45:51.7612898+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "52f3c339-a33b-4516-9c4c-75f89d647ae3",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "2c0a7f1e-d8d5-435b-8791-5b8481532866",
"Sequence": 1,
"AncestorCategoryId": "f5332cc6-aa72-4549-bdde-cc64743d8793",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "9799cc23-e7d6-4582-815b-e7fec88944f7",
"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": "9799cc23-e7d6-4582-815b-e7fec88944f7",
"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": "52f3c339-a33b-4516-9c4c-75f89d647ae3",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "2c0a7f1e-d8d5-435b-8791-5b8481532866",
"Sequence": 1,
"AncestorCategoryId": "f5332cc6-aa72-4549-bdde-cc64743d8793",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "9799cc23-e7d6-4582-815b-e7fec88944f7",
"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": "9799cc23-e7d6-4582-815b-e7fec88944f7",
"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": "92fdd467-beee-403d-8b4a-3d34ec873260",
"CategoryId": "1b2a506c-7ed7-4633-b5e8-1ba7dbc51cb0",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "7dbac1eb-3495-44aa-b111-d7b6ef52ff7c",
"Score": 1.0,
"State": 1
},
{
"Id": "7dbac1eb-3495-44aa-b111-d7b6ef52ff7c",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "8e424b92-49e5-43e3-91b5-0fb0962f1d01",
"Questions": [
{
"Id": "c9fb0a16-6ca4-44bd-8cdf-c31fc0763ad7",
"Answers": "sample string 2"
},
{
"Id": "c9fb0a16-6ca4-44bd-8cdf-c31fc0763ad7",
"Answers": "sample string 2"
}
]
},
{
"Id": "8e424b92-49e5-43e3-91b5-0fb0962f1d01",
"Questions": [
{
"Id": "c9fb0a16-6ca4-44bd-8cdf-c31fc0763ad7",
"Answers": "sample string 2"
},
{
"Id": "c9fb0a16-6ca4-44bd-8cdf-c31fc0763ad7",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "a800258c-9e00-4004-b71e-c48ee0c5ba2e",
"ContentItemId": "d310bd7d-2cf4-4f20-b595-a0d65e451fa8",
"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-04-22T10:45:51.7612898+00:00",
"RescheduleDate": "2026-04-22T10:45:51.7612898+00:00"
},
{
"Id": "a800258c-9e00-4004-b71e-c48ee0c5ba2e",
"ContentItemId": "d310bd7d-2cf4-4f20-b595-a0d65e451fa8",
"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-04-22T10:45:51.7612898+00:00",
"RescheduleDate": "2026-04-22T10:45:51.7612898+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": "cc12c024-6d62-4224-b5c2-ae3b2275d772",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-04-22T10:45:51.8081652+00:00",
"Registration": [
{
"Id": "6ed9bf18-3b14-44b4-8963-bfbcf0bf68b1",
"UserId": "5274dd47-5939-45d7-8566-9614525ada0d",
"IsCurrent": true,
"CenterId": "991a71d5-00fe-419d-a27b-1610bce97037",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "dd60397b-ce3c-4193-8c82-3cf583893a35",
"EndDate": "2026-04-22T10:45:51.7612898+00:00",
"StartDate": "2026-04-22T10:45:51.7612898+00:00",
"SchedulePreferenceDate": "2026-04-22T10:45:51.7612898+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": "6ed9bf18-3b14-44b4-8963-bfbcf0bf68b1",
"UserId": "5274dd47-5939-45d7-8566-9614525ada0d",
"IsCurrent": true,
"CenterId": "991a71d5-00fe-419d-a27b-1610bce97037",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "dd60397b-ce3c-4193-8c82-3cf583893a35",
"EndDate": "2026-04-22T10:45:51.7612898+00:00",
"StartDate": "2026-04-22T10:45:51.7612898+00:00",
"SchedulePreferenceDate": "2026-04-22T10:45:51.7612898+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-04-22T10:45:51.7612898+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "52f3c339-a33b-4516-9c4c-75f89d647ae3",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "2c0a7f1e-d8d5-435b-8791-5b8481532866",
"Sequence": 1,
"AncestorCategoryId": "f5332cc6-aa72-4549-bdde-cc64743d8793",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "9799cc23-e7d6-4582-815b-e7fec88944f7",
"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": "9799cc23-e7d6-4582-815b-e7fec88944f7",
"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": "52f3c339-a33b-4516-9c4c-75f89d647ae3",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "2c0a7f1e-d8d5-435b-8791-5b8481532866",
"Sequence": 1,
"AncestorCategoryId": "f5332cc6-aa72-4549-bdde-cc64743d8793",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "9799cc23-e7d6-4582-815b-e7fec88944f7",
"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": "9799cc23-e7d6-4582-815b-e7fec88944f7",
"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": "92fdd467-beee-403d-8b4a-3d34ec873260",
"CategoryId": "1b2a506c-7ed7-4633-b5e8-1ba7dbc51cb0",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "7dbac1eb-3495-44aa-b111-d7b6ef52ff7c",
"Score": 1.0,
"State": 1
},
{
"Id": "7dbac1eb-3495-44aa-b111-d7b6ef52ff7c",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "8e424b92-49e5-43e3-91b5-0fb0962f1d01",
"Questions": [
{
"Id": "c9fb0a16-6ca4-44bd-8cdf-c31fc0763ad7",
"Answers": "sample string 2"
},
{
"Id": "c9fb0a16-6ca4-44bd-8cdf-c31fc0763ad7",
"Answers": "sample string 2"
}
]
},
{
"Id": "8e424b92-49e5-43e3-91b5-0fb0962f1d01",
"Questions": [
{
"Id": "c9fb0a16-6ca4-44bd-8cdf-c31fc0763ad7",
"Answers": "sample string 2"
},
{
"Id": "c9fb0a16-6ca4-44bd-8cdf-c31fc0763ad7",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "a800258c-9e00-4004-b71e-c48ee0c5ba2e",
"ContentItemId": "d310bd7d-2cf4-4f20-b595-a0d65e451fa8",
"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-04-22T10:45:51.7612898+00:00",
"RescheduleDate": "2026-04-22T10:45:51.7612898+00:00"
},
{
"Id": "a800258c-9e00-4004-b71e-c48ee0c5ba2e",
"ContentItemId": "d310bd7d-2cf4-4f20-b595-a0d65e451fa8",
"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-04-22T10:45:51.7612898+00:00",
"RescheduleDate": "2026-04-22T10:45:51.7612898+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
},
"StudentSpeakPlusLevelInfo": "sample string 5"
}