GET 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.Views.UserStateBackwardCompatibleViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId | globally unique identifier |
None. |
|
| IsNewUser | boolean |
None. |
|
| UserName | string |
None. |
|
| PrivacyPolicyApprove | boolean |
None. |
|
| ServerTime | date |
None. |
|
| Registration | PearsonEnglish.LearningServices.Core.Models.Views.RegistrationViewModel |
None. |
|
| TimeZone | PearsonEnglish.LearningServices.Core.Models.Views.TimeZoneViewModel |
None. |
|
| Bookmarks | Dictionary of string [key] and PearsonEnglish.LearningServices.Core.Models.Views.ContentItemViewModel [value] |
None. |
|
| CurrentCourse | PearsonEnglish.LearningServices.Core.Models.CurrentCourse |
None. |
|
| Lessons | Collection of PearsonEnglish.LearningServices.Core.Models.Views.ContentItemResultViewModel |
None. |
|
| Surveys | Collection of PearsonEnglish.LearningServices.Core.Models.Views.UserSurveyViewModel |
None. |
|
| Sessions | Collection of PearsonEnglish.LearningServices.Core.Models.Views.UserSessionStateViewModel |
None. |
|
| TotalRescheduleCount | integer |
None. |
|
| StudentLevelInfo | PearsonEnglish.LearningServices.Core.Models.StudentLevelInfo |
None. |
Response Formats
application/json
Sample:
{
"UserId": "8c525bbc-ef1a-423f-9d78-9e26eca8368e",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-11-20T06:07:41.6337867+00:00",
"Registration": {
"Id": "b04a8bd9-6da3-4da5-b064-3dd344036bd2",
"UserId": "fad50ca5-ebe5-40de-958e-7eb3085d47ca",
"IsCurrent": true,
"CenterId": "249600fe-f71e-4260-98a3-35e083ae9f87",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "acf90a6e-85b5-4289-a7fc-48d16cffba28",
"EndDate": "2026-11-20T06:07:41.6181873+00:00",
"StartDate": "2026-11-20T06:07:41.6181873+00:00",
"SchedulePreferenceDate": "2026-11-20T06:07:41.6181873+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-20T06:07:41.6181873+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "1e573cc0-dedf-4d74-8846-541e9dfb610c",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "5d2cf4be-6fa5-4084-9b0b-3a04d223f8f8",
"Sequence": 1,
"AncestorCategoryId": "51914d06-2c98-44c6-8e13-31a27f46ecc9",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "ce57dc13-e490-4ae0-8ed7-a02b288e51d7",
"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": "ce57dc13-e490-4ae0-8ed7-a02b288e51d7",
"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": "1e573cc0-dedf-4d74-8846-541e9dfb610c",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "5d2cf4be-6fa5-4084-9b0b-3a04d223f8f8",
"Sequence": 1,
"AncestorCategoryId": "51914d06-2c98-44c6-8e13-31a27f46ecc9",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "ce57dc13-e490-4ae0-8ed7-a02b288e51d7",
"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": "ce57dc13-e490-4ae0-8ed7-a02b288e51d7",
"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": "d86a8166-04fc-43bf-aad5-76ff1191a252",
"CategoryId": "7ab61c51-b325-404d-80e5-8b5c96979733",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "def6eab7-4aae-440e-8827-2ec761551fdf",
"Score": 1.0,
"State": 1
},
{
"Id": "def6eab7-4aae-440e-8827-2ec761551fdf",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "3a4f6b7a-acad-4509-a04e-4e2abc7a40a8",
"Questions": [
{
"Id": "b1df80a9-d26b-4290-b551-adc073431e67",
"Answers": "sample string 2"
},
{
"Id": "b1df80a9-d26b-4290-b551-adc073431e67",
"Answers": "sample string 2"
}
]
},
{
"Id": "3a4f6b7a-acad-4509-a04e-4e2abc7a40a8",
"Questions": [
{
"Id": "b1df80a9-d26b-4290-b551-adc073431e67",
"Answers": "sample string 2"
},
{
"Id": "b1df80a9-d26b-4290-b551-adc073431e67",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "80fcfb39-50cc-4fed-b244-c105f88ce61f",
"ContentItemId": "e723d46c-3227-4ef9-b8c4-a3e9de38115d",
"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-20T06:07:41.6181873+00:00",
"RescheduleDate": "2026-11-20T06:07:41.6181873+00:00"
},
{
"Id": "80fcfb39-50cc-4fed-b244-c105f88ce61f",
"ContentItemId": "e723d46c-3227-4ef9-b8c4-a3e9de38115d",
"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-20T06:07:41.6181873+00:00",
"RescheduleDate": "2026-11-20T06:07:41.6181873+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}
text/json
Sample:
{
"UserId": "8c525bbc-ef1a-423f-9d78-9e26eca8368e",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-11-20T06:07:41.6650354+00:00",
"Registration": {
"Id": "b04a8bd9-6da3-4da5-b064-3dd344036bd2",
"UserId": "fad50ca5-ebe5-40de-958e-7eb3085d47ca",
"IsCurrent": true,
"CenterId": "249600fe-f71e-4260-98a3-35e083ae9f87",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "acf90a6e-85b5-4289-a7fc-48d16cffba28",
"EndDate": "2026-11-20T06:07:41.6181873+00:00",
"StartDate": "2026-11-20T06:07:41.6181873+00:00",
"SchedulePreferenceDate": "2026-11-20T06:07:41.6181873+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-20T06:07:41.6181873+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "1e573cc0-dedf-4d74-8846-541e9dfb610c",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "5d2cf4be-6fa5-4084-9b0b-3a04d223f8f8",
"Sequence": 1,
"AncestorCategoryId": "51914d06-2c98-44c6-8e13-31a27f46ecc9",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "ce57dc13-e490-4ae0-8ed7-a02b288e51d7",
"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": "ce57dc13-e490-4ae0-8ed7-a02b288e51d7",
"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": "1e573cc0-dedf-4d74-8846-541e9dfb610c",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "5d2cf4be-6fa5-4084-9b0b-3a04d223f8f8",
"Sequence": 1,
"AncestorCategoryId": "51914d06-2c98-44c6-8e13-31a27f46ecc9",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "ce57dc13-e490-4ae0-8ed7-a02b288e51d7",
"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": "ce57dc13-e490-4ae0-8ed7-a02b288e51d7",
"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": "d86a8166-04fc-43bf-aad5-76ff1191a252",
"CategoryId": "7ab61c51-b325-404d-80e5-8b5c96979733",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "def6eab7-4aae-440e-8827-2ec761551fdf",
"Score": 1.0,
"State": 1
},
{
"Id": "def6eab7-4aae-440e-8827-2ec761551fdf",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "3a4f6b7a-acad-4509-a04e-4e2abc7a40a8",
"Questions": [
{
"Id": "b1df80a9-d26b-4290-b551-adc073431e67",
"Answers": "sample string 2"
},
{
"Id": "b1df80a9-d26b-4290-b551-adc073431e67",
"Answers": "sample string 2"
}
]
},
{
"Id": "3a4f6b7a-acad-4509-a04e-4e2abc7a40a8",
"Questions": [
{
"Id": "b1df80a9-d26b-4290-b551-adc073431e67",
"Answers": "sample string 2"
},
{
"Id": "b1df80a9-d26b-4290-b551-adc073431e67",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "80fcfb39-50cc-4fed-b244-c105f88ce61f",
"ContentItemId": "e723d46c-3227-4ef9-b8c4-a3e9de38115d",
"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-20T06:07:41.6181873+00:00",
"RescheduleDate": "2026-11-20T06:07:41.6181873+00:00"
},
{
"Id": "80fcfb39-50cc-4fed-b244-c105f88ce61f",
"ContentItemId": "e723d46c-3227-4ef9-b8c4-a3e9de38115d",
"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-20T06:07:41.6181873+00:00",
"RescheduleDate": "2026-11-20T06:07:41.6181873+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}