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": "7e2a89bb-9231-4887-a192-157c6dcc1782",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-08-27T13:23:39.1399629+00:00",
"Registration": {
"Id": "275d1911-ba76-4b40-92de-15a9a607f924",
"UserId": "e9faf3e1-6102-41d5-b82d-1fcee1fa3a69",
"IsCurrent": true,
"CenterId": "2d40f6ca-a7f1-4d2c-a37a-c1a5864f7643",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "e15844f8-8a9a-4537-b1bb-1a497829b652",
"EndDate": "2026-08-27T13:23:39.1243359+00:00",
"StartDate": "2026-08-27T13:23:39.1243359+00:00",
"SchedulePreferenceDate": "2026-08-27T13:23:39.1243359+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-27T13:23:39.1243359+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "25eb91cc-8a0e-464a-a98e-c39c2a83ee87",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "cac61e05-8f64-4f46-9f0a-262cd806f407",
"Sequence": 1,
"AncestorCategoryId": "7eeebf60-f95e-49af-96dc-68d365f6b1e9",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "af4345cd-68ee-4d0b-a3cc-0797395dc47a",
"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": "af4345cd-68ee-4d0b-a3cc-0797395dc47a",
"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": "25eb91cc-8a0e-464a-a98e-c39c2a83ee87",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "cac61e05-8f64-4f46-9f0a-262cd806f407",
"Sequence": 1,
"AncestorCategoryId": "7eeebf60-f95e-49af-96dc-68d365f6b1e9",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "af4345cd-68ee-4d0b-a3cc-0797395dc47a",
"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": "af4345cd-68ee-4d0b-a3cc-0797395dc47a",
"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": "973e0a32-2e9a-4c3d-8ab8-8478c324e681",
"CategoryId": "ff15885b-4f03-4e8c-bac9-82a83bf4ee13",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "040133b4-5292-4a60-b35b-a9c423c0bce8",
"Score": 1.0,
"State": 1
},
{
"Id": "040133b4-5292-4a60-b35b-a9c423c0bce8",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "f337fa36-27da-456d-8be3-949611d75767",
"Questions": [
{
"Id": "9aeba4c2-61a2-495d-bc4a-d2b7ea2af807",
"Answers": "sample string 2"
},
{
"Id": "9aeba4c2-61a2-495d-bc4a-d2b7ea2af807",
"Answers": "sample string 2"
}
]
},
{
"Id": "f337fa36-27da-456d-8be3-949611d75767",
"Questions": [
{
"Id": "9aeba4c2-61a2-495d-bc4a-d2b7ea2af807",
"Answers": "sample string 2"
},
{
"Id": "9aeba4c2-61a2-495d-bc4a-d2b7ea2af807",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "be563c6d-bee5-4195-ad71-5a8cdac09351",
"ContentItemId": "d7e78410-3178-4487-baec-7af808c608fa",
"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-27T13:23:39.1243359+00:00",
"RescheduleDate": "2026-08-27T13:23:39.1243359+00:00"
},
{
"Id": "be563c6d-bee5-4195-ad71-5a8cdac09351",
"ContentItemId": "d7e78410-3178-4487-baec-7af808c608fa",
"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-27T13:23:39.1243359+00:00",
"RescheduleDate": "2026-08-27T13:23:39.1243359+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}
text/json
Sample:
{
"UserId": "7e2a89bb-9231-4887-a192-157c6dcc1782",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-08-27T13:23:39.1868375+00:00",
"Registration": {
"Id": "275d1911-ba76-4b40-92de-15a9a607f924",
"UserId": "e9faf3e1-6102-41d5-b82d-1fcee1fa3a69",
"IsCurrent": true,
"CenterId": "2d40f6ca-a7f1-4d2c-a37a-c1a5864f7643",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "e15844f8-8a9a-4537-b1bb-1a497829b652",
"EndDate": "2026-08-27T13:23:39.1243359+00:00",
"StartDate": "2026-08-27T13:23:39.1243359+00:00",
"SchedulePreferenceDate": "2026-08-27T13:23:39.1243359+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-27T13:23:39.1243359+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "25eb91cc-8a0e-464a-a98e-c39c2a83ee87",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "cac61e05-8f64-4f46-9f0a-262cd806f407",
"Sequence": 1,
"AncestorCategoryId": "7eeebf60-f95e-49af-96dc-68d365f6b1e9",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "af4345cd-68ee-4d0b-a3cc-0797395dc47a",
"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": "af4345cd-68ee-4d0b-a3cc-0797395dc47a",
"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": "25eb91cc-8a0e-464a-a98e-c39c2a83ee87",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "cac61e05-8f64-4f46-9f0a-262cd806f407",
"Sequence": 1,
"AncestorCategoryId": "7eeebf60-f95e-49af-96dc-68d365f6b1e9",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "af4345cd-68ee-4d0b-a3cc-0797395dc47a",
"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": "af4345cd-68ee-4d0b-a3cc-0797395dc47a",
"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": "973e0a32-2e9a-4c3d-8ab8-8478c324e681",
"CategoryId": "ff15885b-4f03-4e8c-bac9-82a83bf4ee13",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "040133b4-5292-4a60-b35b-a9c423c0bce8",
"Score": 1.0,
"State": 1
},
{
"Id": "040133b4-5292-4a60-b35b-a9c423c0bce8",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "f337fa36-27da-456d-8be3-949611d75767",
"Questions": [
{
"Id": "9aeba4c2-61a2-495d-bc4a-d2b7ea2af807",
"Answers": "sample string 2"
},
{
"Id": "9aeba4c2-61a2-495d-bc4a-d2b7ea2af807",
"Answers": "sample string 2"
}
]
},
{
"Id": "f337fa36-27da-456d-8be3-949611d75767",
"Questions": [
{
"Id": "9aeba4c2-61a2-495d-bc4a-d2b7ea2af807",
"Answers": "sample string 2"
},
{
"Id": "9aeba4c2-61a2-495d-bc4a-d2b7ea2af807",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "be563c6d-bee5-4195-ad71-5a8cdac09351",
"ContentItemId": "d7e78410-3178-4487-baec-7af808c608fa",
"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-27T13:23:39.1243359+00:00",
"RescheduleDate": "2026-08-27T13:23:39.1243359+00:00"
},
{
"Id": "be563c6d-bee5-4195-ad71-5a8cdac09351",
"ContentItemId": "d7e78410-3178-4487-baec-7af808c608fa",
"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-27T13:23:39.1243359+00:00",
"RescheduleDate": "2026-08-27T13:23:39.1243359+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}