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": "b1f764c4-aa59-4ba8-bdfe-2582a3b2f704",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-11-20T08:09:50.0324901+00:00",
"Registration": [
{
"Id": "4ce2434b-a7e4-4064-86c0-bd25e9aba4a4",
"UserId": "2e52ed32-16f2-466b-94db-8ebaab6c8838",
"IsCurrent": true,
"CenterId": "0f0e21e2-4f0a-4358-9e61-2b10881e2afe",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "c5b217c0-9ee8-4ba0-a5b8-d382e7980008",
"EndDate": "2026-11-20T08:09:50.016864+00:00",
"StartDate": "2026-11-20T08:09:50.016864+00:00",
"SchedulePreferenceDate": "2026-11-20T08:09:50.016864+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": "4ce2434b-a7e4-4064-86c0-bd25e9aba4a4",
"UserId": "2e52ed32-16f2-466b-94db-8ebaab6c8838",
"IsCurrent": true,
"CenterId": "0f0e21e2-4f0a-4358-9e61-2b10881e2afe",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "c5b217c0-9ee8-4ba0-a5b8-d382e7980008",
"EndDate": "2026-11-20T08:09:50.016864+00:00",
"StartDate": "2026-11-20T08:09:50.016864+00:00",
"SchedulePreferenceDate": "2026-11-20T08:09:50.016864+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-20T08:09:50.016864+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "522dfb2c-33f4-4133-8c59-c14fa176e62f",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "298361ad-bb01-469d-9530-4b9751e8e526",
"Sequence": 1,
"AncestorCategoryId": "1e415d5d-a89b-4ea0-a1a2-a60cfe0d34c6",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "b76e3be0-1083-4137-a0d3-d126fd68cce7",
"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": "b76e3be0-1083-4137-a0d3-d126fd68cce7",
"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": "522dfb2c-33f4-4133-8c59-c14fa176e62f",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "298361ad-bb01-469d-9530-4b9751e8e526",
"Sequence": 1,
"AncestorCategoryId": "1e415d5d-a89b-4ea0-a1a2-a60cfe0d34c6",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "b76e3be0-1083-4137-a0d3-d126fd68cce7",
"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": "b76e3be0-1083-4137-a0d3-d126fd68cce7",
"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": "40546762-7672-4f50-aafa-a390ab8d5bf0",
"CategoryId": "5a672b16-1ad6-47cb-a12e-fceaf7762ea8",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "ec1e977c-1de1-423e-8a18-cf476ae5e29a",
"Score": 1.0,
"State": 1
},
{
"Id": "ec1e977c-1de1-423e-8a18-cf476ae5e29a",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "e2e7ad40-b5ad-4ad8-a3f8-361a316527cd",
"Questions": [
{
"Id": "77dbb416-9a35-4306-9825-464f5f5d4ccf",
"Answers": "sample string 2"
},
{
"Id": "77dbb416-9a35-4306-9825-464f5f5d4ccf",
"Answers": "sample string 2"
}
]
},
{
"Id": "e2e7ad40-b5ad-4ad8-a3f8-361a316527cd",
"Questions": [
{
"Id": "77dbb416-9a35-4306-9825-464f5f5d4ccf",
"Answers": "sample string 2"
},
{
"Id": "77dbb416-9a35-4306-9825-464f5f5d4ccf",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "0f024e55-0bd3-4699-9a66-9270950f9c2f",
"ContentItemId": "34206f33-05d7-4c36-b726-1e88045f48b1",
"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-20T08:09:50.016864+00:00",
"RescheduleDate": "2026-11-20T08:09:50.016864+00:00"
},
{
"Id": "0f024e55-0bd3-4699-9a66-9270950f9c2f",
"ContentItemId": "34206f33-05d7-4c36-b726-1e88045f48b1",
"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-20T08:09:50.016864+00:00",
"RescheduleDate": "2026-11-20T08:09:50.016864+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": "b1f764c4-aa59-4ba8-bdfe-2582a3b2f704",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-11-20T08:09:50.0481165+00:00",
"Registration": [
{
"Id": "4ce2434b-a7e4-4064-86c0-bd25e9aba4a4",
"UserId": "2e52ed32-16f2-466b-94db-8ebaab6c8838",
"IsCurrent": true,
"CenterId": "0f0e21e2-4f0a-4358-9e61-2b10881e2afe",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "c5b217c0-9ee8-4ba0-a5b8-d382e7980008",
"EndDate": "2026-11-20T08:09:50.016864+00:00",
"StartDate": "2026-11-20T08:09:50.016864+00:00",
"SchedulePreferenceDate": "2026-11-20T08:09:50.016864+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": "4ce2434b-a7e4-4064-86c0-bd25e9aba4a4",
"UserId": "2e52ed32-16f2-466b-94db-8ebaab6c8838",
"IsCurrent": true,
"CenterId": "0f0e21e2-4f0a-4358-9e61-2b10881e2afe",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "c5b217c0-9ee8-4ba0-a5b8-d382e7980008",
"EndDate": "2026-11-20T08:09:50.016864+00:00",
"StartDate": "2026-11-20T08:09:50.016864+00:00",
"SchedulePreferenceDate": "2026-11-20T08:09:50.016864+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-20T08:09:50.016864+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "522dfb2c-33f4-4133-8c59-c14fa176e62f",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "298361ad-bb01-469d-9530-4b9751e8e526",
"Sequence": 1,
"AncestorCategoryId": "1e415d5d-a89b-4ea0-a1a2-a60cfe0d34c6",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "b76e3be0-1083-4137-a0d3-d126fd68cce7",
"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": "b76e3be0-1083-4137-a0d3-d126fd68cce7",
"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": "522dfb2c-33f4-4133-8c59-c14fa176e62f",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "298361ad-bb01-469d-9530-4b9751e8e526",
"Sequence": 1,
"AncestorCategoryId": "1e415d5d-a89b-4ea0-a1a2-a60cfe0d34c6",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "b76e3be0-1083-4137-a0d3-d126fd68cce7",
"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": "b76e3be0-1083-4137-a0d3-d126fd68cce7",
"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": "40546762-7672-4f50-aafa-a390ab8d5bf0",
"CategoryId": "5a672b16-1ad6-47cb-a12e-fceaf7762ea8",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "ec1e977c-1de1-423e-8a18-cf476ae5e29a",
"Score": 1.0,
"State": 1
},
{
"Id": "ec1e977c-1de1-423e-8a18-cf476ae5e29a",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "e2e7ad40-b5ad-4ad8-a3f8-361a316527cd",
"Questions": [
{
"Id": "77dbb416-9a35-4306-9825-464f5f5d4ccf",
"Answers": "sample string 2"
},
{
"Id": "77dbb416-9a35-4306-9825-464f5f5d4ccf",
"Answers": "sample string 2"
}
]
},
{
"Id": "e2e7ad40-b5ad-4ad8-a3f8-361a316527cd",
"Questions": [
{
"Id": "77dbb416-9a35-4306-9825-464f5f5d4ccf",
"Answers": "sample string 2"
},
{
"Id": "77dbb416-9a35-4306-9825-464f5f5d4ccf",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "0f024e55-0bd3-4699-9a66-9270950f9c2f",
"ContentItemId": "34206f33-05d7-4c36-b726-1e88045f48b1",
"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-20T08:09:50.016864+00:00",
"RescheduleDate": "2026-11-20T08:09:50.016864+00:00"
},
{
"Id": "0f024e55-0bd3-4699-9a66-9270950f9c2f",
"ContentItemId": "34206f33-05d7-4c36-b726-1e88045f48b1",
"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-20T08:09:50.016864+00:00",
"RescheduleDate": "2026-11-20T08:09:50.016864+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
},
"StudentSpeakPlusLevelInfo": "sample string 5"
}