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": "0d19b07c-4d3e-4298-9016-8ca976ed9cad",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-09-02T15:50:41.51479+00:00",
"Registration": {
"Id": "96e38ced-5855-4fe0-994d-28df89029224",
"UserId": "2231b9b7-33a4-462e-bbd4-8994200ac93c",
"IsCurrent": true,
"CenterId": "fee54d5d-8a92-453a-9f41-318916e79df7",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "2b27f3c0-12ff-416d-9116-8054210bfc09",
"EndDate": "2026-09-02T15:50:41.4991653+00:00",
"StartDate": "2026-09-02T15:50:41.4991653+00:00",
"SchedulePreferenceDate": "2026-09-02T15:50:41.4991653+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-09-02T15:50:41.4991653+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "b08eb7f8-36e7-46ad-8b80-f9a53cb009ec",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "f3bd929d-8f97-4a6f-bdbe-4289a3619f31",
"Sequence": 1,
"AncestorCategoryId": "dc312ca9-2608-4db3-9fc1-fbc7fa12e9b5",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "dc11eced-8de1-4ad2-a752-8372aa32e1ea",
"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": "dc11eced-8de1-4ad2-a752-8372aa32e1ea",
"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": "b08eb7f8-36e7-46ad-8b80-f9a53cb009ec",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "f3bd929d-8f97-4a6f-bdbe-4289a3619f31",
"Sequence": 1,
"AncestorCategoryId": "dc312ca9-2608-4db3-9fc1-fbc7fa12e9b5",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "dc11eced-8de1-4ad2-a752-8372aa32e1ea",
"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": "dc11eced-8de1-4ad2-a752-8372aa32e1ea",
"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": "ebd02df8-3107-4145-a1ef-0899c2e41f96",
"CategoryId": "f9c87b89-7e09-4eea-bfe1-d4fa0ed05378",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "8c68b478-8f8b-4dfd-b206-789490947d6c",
"Score": 1.0,
"State": 1
},
{
"Id": "8c68b478-8f8b-4dfd-b206-789490947d6c",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "43a4a5de-e8b3-418b-b84c-77ed29b965e7",
"Questions": [
{
"Id": "482c4b1e-7fb8-4294-bd1c-64857a69d50d",
"Answers": "sample string 2"
},
{
"Id": "482c4b1e-7fb8-4294-bd1c-64857a69d50d",
"Answers": "sample string 2"
}
]
},
{
"Id": "43a4a5de-e8b3-418b-b84c-77ed29b965e7",
"Questions": [
{
"Id": "482c4b1e-7fb8-4294-bd1c-64857a69d50d",
"Answers": "sample string 2"
},
{
"Id": "482c4b1e-7fb8-4294-bd1c-64857a69d50d",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "7e5d1c6f-ea36-4564-91de-9c565ea5b6da",
"ContentItemId": "7716b27d-5231-425d-bd24-244296c7610e",
"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-09-02T15:50:41.4991653+00:00",
"RescheduleDate": "2026-09-02T15:50:41.4991653+00:00"
},
{
"Id": "7e5d1c6f-ea36-4564-91de-9c565ea5b6da",
"ContentItemId": "7716b27d-5231-425d-bd24-244296c7610e",
"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-09-02T15:50:41.4991653+00:00",
"RescheduleDate": "2026-09-02T15:50:41.4991653+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}
text/json
Sample:
{
"UserId": "0d19b07c-4d3e-4298-9016-8ca976ed9cad",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-09-02T15:50:41.5616682+00:00",
"Registration": {
"Id": "96e38ced-5855-4fe0-994d-28df89029224",
"UserId": "2231b9b7-33a4-462e-bbd4-8994200ac93c",
"IsCurrent": true,
"CenterId": "fee54d5d-8a92-453a-9f41-318916e79df7",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "2b27f3c0-12ff-416d-9116-8054210bfc09",
"EndDate": "2026-09-02T15:50:41.4991653+00:00",
"StartDate": "2026-09-02T15:50:41.4991653+00:00",
"SchedulePreferenceDate": "2026-09-02T15:50:41.4991653+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-09-02T15:50:41.4991653+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "b08eb7f8-36e7-46ad-8b80-f9a53cb009ec",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "f3bd929d-8f97-4a6f-bdbe-4289a3619f31",
"Sequence": 1,
"AncestorCategoryId": "dc312ca9-2608-4db3-9fc1-fbc7fa12e9b5",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "dc11eced-8de1-4ad2-a752-8372aa32e1ea",
"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": "dc11eced-8de1-4ad2-a752-8372aa32e1ea",
"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": "b08eb7f8-36e7-46ad-8b80-f9a53cb009ec",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "f3bd929d-8f97-4a6f-bdbe-4289a3619f31",
"Sequence": 1,
"AncestorCategoryId": "dc312ca9-2608-4db3-9fc1-fbc7fa12e9b5",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "dc11eced-8de1-4ad2-a752-8372aa32e1ea",
"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": "dc11eced-8de1-4ad2-a752-8372aa32e1ea",
"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": "ebd02df8-3107-4145-a1ef-0899c2e41f96",
"CategoryId": "f9c87b89-7e09-4eea-bfe1-d4fa0ed05378",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "8c68b478-8f8b-4dfd-b206-789490947d6c",
"Score": 1.0,
"State": 1
},
{
"Id": "8c68b478-8f8b-4dfd-b206-789490947d6c",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "43a4a5de-e8b3-418b-b84c-77ed29b965e7",
"Questions": [
{
"Id": "482c4b1e-7fb8-4294-bd1c-64857a69d50d",
"Answers": "sample string 2"
},
{
"Id": "482c4b1e-7fb8-4294-bd1c-64857a69d50d",
"Answers": "sample string 2"
}
]
},
{
"Id": "43a4a5de-e8b3-418b-b84c-77ed29b965e7",
"Questions": [
{
"Id": "482c4b1e-7fb8-4294-bd1c-64857a69d50d",
"Answers": "sample string 2"
},
{
"Id": "482c4b1e-7fb8-4294-bd1c-64857a69d50d",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "7e5d1c6f-ea36-4564-91de-9c565ea5b6da",
"ContentItemId": "7716b27d-5231-425d-bd24-244296c7610e",
"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-09-02T15:50:41.4991653+00:00",
"RescheduleDate": "2026-09-02T15:50:41.4991653+00:00"
},
{
"Id": "7e5d1c6f-ea36-4564-91de-9c565ea5b6da",
"ContentItemId": "7716b27d-5231-425d-bd24-244296c7610e",
"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-09-02T15:50:41.4991653+00:00",
"RescheduleDate": "2026-09-02T15:50:41.4991653+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}