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": "cb1f58e7-3307-43f7-869b-89937c433a01",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-08-06T08:30:56.6996562+00:00",
"Registration": {
"Id": "c894efc9-cdf7-4cd4-b5c8-570d1ae5252c",
"UserId": "b9a47abb-91b1-4f1d-94d3-141f7eb5efdb",
"IsCurrent": true,
"CenterId": "f4475aef-602c-4e9e-bbcc-beda8a75120a",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "ddee24b1-3516-48ce-8e70-99a86c982ebb",
"EndDate": "2026-08-06T08:30:56.6840305+00:00",
"StartDate": "2026-08-06T08:30:56.6840305+00:00",
"SchedulePreferenceDate": "2026-08-06T08:30:56.6840305+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-08-06T08:30:56.6840305+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "a65bb49e-de42-4efb-8095-7835ce53102a",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "07689ee2-3ecf-4bb9-8b05-d27a7a4fd39b",
"Sequence": 1,
"AncestorCategoryId": "757c825a-ee8b-4f3a-8d2f-e18339dc558e",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "621636a4-a8a2-4eeb-a623-464990796913",
"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": "621636a4-a8a2-4eeb-a623-464990796913",
"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": "a65bb49e-de42-4efb-8095-7835ce53102a",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "07689ee2-3ecf-4bb9-8b05-d27a7a4fd39b",
"Sequence": 1,
"AncestorCategoryId": "757c825a-ee8b-4f3a-8d2f-e18339dc558e",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "621636a4-a8a2-4eeb-a623-464990796913",
"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": "621636a4-a8a2-4eeb-a623-464990796913",
"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": "df1613c5-b7ab-4f36-9bb0-f6357c5a9f61",
"CategoryId": "61ee26be-87d7-42db-851d-a436e1f247a8",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "d6221f3c-6280-4474-b086-9daa4cf2166e",
"Score": 1.0,
"State": 1
},
{
"Id": "d6221f3c-6280-4474-b086-9daa4cf2166e",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "bc0387b7-cd71-4d49-b48e-e3e5b95ad22b",
"Questions": [
{
"Id": "69a1334b-1d48-4a22-a8ef-64113b5ff7df",
"Answers": "sample string 2"
},
{
"Id": "69a1334b-1d48-4a22-a8ef-64113b5ff7df",
"Answers": "sample string 2"
}
]
},
{
"Id": "bc0387b7-cd71-4d49-b48e-e3e5b95ad22b",
"Questions": [
{
"Id": "69a1334b-1d48-4a22-a8ef-64113b5ff7df",
"Answers": "sample string 2"
},
{
"Id": "69a1334b-1d48-4a22-a8ef-64113b5ff7df",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "03360862-8978-4ca2-88f7-78062d21a51f",
"ContentItemId": "48b47d29-8ea3-4737-9593-593c167c5816",
"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-08-06T08:30:56.6840305+00:00",
"RescheduleDate": "2026-08-06T08:30:56.6840305+00:00"
},
{
"Id": "03360862-8978-4ca2-88f7-78062d21a51f",
"ContentItemId": "48b47d29-8ea3-4737-9593-593c167c5816",
"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-08-06T08:30:56.6840305+00:00",
"RescheduleDate": "2026-08-06T08:30:56.6840305+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}
text/json
Sample:
{
"UserId": "cb1f58e7-3307-43f7-869b-89937c433a01",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-08-06T08:30:56.7465329+00:00",
"Registration": {
"Id": "c894efc9-cdf7-4cd4-b5c8-570d1ae5252c",
"UserId": "b9a47abb-91b1-4f1d-94d3-141f7eb5efdb",
"IsCurrent": true,
"CenterId": "f4475aef-602c-4e9e-bbcc-beda8a75120a",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "ddee24b1-3516-48ce-8e70-99a86c982ebb",
"EndDate": "2026-08-06T08:30:56.6840305+00:00",
"StartDate": "2026-08-06T08:30:56.6840305+00:00",
"SchedulePreferenceDate": "2026-08-06T08:30:56.6840305+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-08-06T08:30:56.6840305+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "a65bb49e-de42-4efb-8095-7835ce53102a",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "07689ee2-3ecf-4bb9-8b05-d27a7a4fd39b",
"Sequence": 1,
"AncestorCategoryId": "757c825a-ee8b-4f3a-8d2f-e18339dc558e",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "621636a4-a8a2-4eeb-a623-464990796913",
"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": "621636a4-a8a2-4eeb-a623-464990796913",
"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": "a65bb49e-de42-4efb-8095-7835ce53102a",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "07689ee2-3ecf-4bb9-8b05-d27a7a4fd39b",
"Sequence": 1,
"AncestorCategoryId": "757c825a-ee8b-4f3a-8d2f-e18339dc558e",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "621636a4-a8a2-4eeb-a623-464990796913",
"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": "621636a4-a8a2-4eeb-a623-464990796913",
"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": "df1613c5-b7ab-4f36-9bb0-f6357c5a9f61",
"CategoryId": "61ee26be-87d7-42db-851d-a436e1f247a8",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "d6221f3c-6280-4474-b086-9daa4cf2166e",
"Score": 1.0,
"State": 1
},
{
"Id": "d6221f3c-6280-4474-b086-9daa4cf2166e",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "bc0387b7-cd71-4d49-b48e-e3e5b95ad22b",
"Questions": [
{
"Id": "69a1334b-1d48-4a22-a8ef-64113b5ff7df",
"Answers": "sample string 2"
},
{
"Id": "69a1334b-1d48-4a22-a8ef-64113b5ff7df",
"Answers": "sample string 2"
}
]
},
{
"Id": "bc0387b7-cd71-4d49-b48e-e3e5b95ad22b",
"Questions": [
{
"Id": "69a1334b-1d48-4a22-a8ef-64113b5ff7df",
"Answers": "sample string 2"
},
{
"Id": "69a1334b-1d48-4a22-a8ef-64113b5ff7df",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "03360862-8978-4ca2-88f7-78062d21a51f",
"ContentItemId": "48b47d29-8ea3-4737-9593-593c167c5816",
"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-08-06T08:30:56.6840305+00:00",
"RescheduleDate": "2026-08-06T08:30:56.6840305+00:00"
},
{
"Id": "03360862-8978-4ca2-88f7-78062d21a51f",
"ContentItemId": "48b47d29-8ea3-4737-9593-593c167c5816",
"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-08-06T08:30:56.6840305+00:00",
"RescheduleDate": "2026-08-06T08:30:56.6840305+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}