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": "530cc830-7efb-419a-ad0d-95fea22eae9f",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-08-17T22:06:38.3595612+00:00",
"Registration": {
"Id": "7866cf59-1c34-43bb-a412-a495c82eb837",
"UserId": "221c3e14-5f8d-4747-9653-f5356e0b2dc1",
"IsCurrent": true,
"CenterId": "4fbdac8e-13b8-4d37-a91c-13e8fe287384",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "a11e7759-b68a-48d9-86db-8d71f76bc33e",
"EndDate": "2026-08-17T22:06:38.3595612+00:00",
"StartDate": "2026-08-17T22:06:38.3595612+00:00",
"SchedulePreferenceDate": "2026-08-17T22:06:38.3595612+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-17T22:06:38.3595612+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "024a822d-0dfb-49e2-a030-17b8492286ad",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "035c2244-be33-445a-82b4-d0d15f3bdb61",
"Sequence": 1,
"AncestorCategoryId": "982f43bf-b4c0-4a2b-94a6-ba1a16c9a5c5",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "aa8fd153-900c-4e58-bfd4-c2d3d2d5effe",
"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": "aa8fd153-900c-4e58-bfd4-c2d3d2d5effe",
"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": "024a822d-0dfb-49e2-a030-17b8492286ad",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "035c2244-be33-445a-82b4-d0d15f3bdb61",
"Sequence": 1,
"AncestorCategoryId": "982f43bf-b4c0-4a2b-94a6-ba1a16c9a5c5",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "aa8fd153-900c-4e58-bfd4-c2d3d2d5effe",
"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": "aa8fd153-900c-4e58-bfd4-c2d3d2d5effe",
"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": "84e90003-c0fb-4462-a4bb-7d08fd9bac4d",
"CategoryId": "4008ac81-5a0e-4cde-867e-02fe333f35af",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "008b8c68-8421-4f82-8c36-ecce8f8ab3e8",
"Score": 1.0,
"State": 1
},
{
"Id": "008b8c68-8421-4f82-8c36-ecce8f8ab3e8",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "4747c712-f255-4ac2-916c-f4c5c15a9997",
"Questions": [
{
"Id": "94baff16-cfee-4439-bf78-b01d81666310",
"Answers": "sample string 2"
},
{
"Id": "94baff16-cfee-4439-bf78-b01d81666310",
"Answers": "sample string 2"
}
]
},
{
"Id": "4747c712-f255-4ac2-916c-f4c5c15a9997",
"Questions": [
{
"Id": "94baff16-cfee-4439-bf78-b01d81666310",
"Answers": "sample string 2"
},
{
"Id": "94baff16-cfee-4439-bf78-b01d81666310",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "c802cb43-c140-4c4b-9c34-cc5a4955e0ed",
"ContentItemId": "efd32e99-d390-45fe-8907-09c208416821",
"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-17T22:06:38.3595612+00:00",
"RescheduleDate": "2026-08-17T22:06:38.3595612+00:00"
},
{
"Id": "c802cb43-c140-4c4b-9c34-cc5a4955e0ed",
"ContentItemId": "efd32e99-d390-45fe-8907-09c208416821",
"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-17T22:06:38.3595612+00:00",
"RescheduleDate": "2026-08-17T22:06:38.3595612+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}
text/json
Sample:
{
"UserId": "530cc830-7efb-419a-ad0d-95fea22eae9f",
"IsNewUser": true,
"UserName": "sample string 3",
"PrivacyPolicyApprove": true,
"ServerTime": "2026-08-17T22:06:38.3751992+00:00",
"Registration": {
"Id": "7866cf59-1c34-43bb-a412-a495c82eb837",
"UserId": "221c3e14-5f8d-4747-9653-f5356e0b2dc1",
"IsCurrent": true,
"CenterId": "4fbdac8e-13b8-4d37-a91c-13e8fe287384",
"CenterZone": 5,
"ContractId": "sample string 6",
"CurrentContentItemId": "a11e7759-b68a-48d9-86db-8d71f76bc33e",
"EndDate": "2026-08-17T22:06:38.3595612+00:00",
"StartDate": "2026-08-17T22:06:38.3595612+00:00",
"SchedulePreferenceDate": "2026-08-17T22:06:38.3595612+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-17T22:06:38.3595612+00:00"
},
"Bookmarks": {
"sample string 1": {
"Id": "024a822d-0dfb-49e2-a030-17b8492286ad",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "035c2244-be33-445a-82b4-d0d15f3bdb61",
"Sequence": 1,
"AncestorCategoryId": "982f43bf-b4c0-4a2b-94a6-ba1a16c9a5c5",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "aa8fd153-900c-4e58-bfd4-c2d3d2d5effe",
"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": "aa8fd153-900c-4e58-bfd4-c2d3d2d5effe",
"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": "024a822d-0dfb-49e2-a030-17b8492286ad",
"Description": "sample string 2",
"Duration": 1,
"IsSkippable": true,
"Url": "sample string 3",
"CourseId": "035c2244-be33-445a-82b4-d0d15f3bdb61",
"Sequence": 1,
"AncestorCategoryId": "982f43bf-b4c0-4a2b-94a6-ba1a16c9a5c5",
"TypeId": 5,
"TypeName": "sample string 6",
"Hierarchy": [
{
"Id": "aa8fd153-900c-4e58-bfd4-c2d3d2d5effe",
"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": "aa8fd153-900c-4e58-bfd4-c2d3d2d5effe",
"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": "84e90003-c0fb-4462-a4bb-7d08fd9bac4d",
"CategoryId": "4008ac81-5a0e-4cde-867e-02fe333f35af",
"DisclaimerConfirmed": true
},
"Lessons": [
{
"Id": "008b8c68-8421-4f82-8c36-ecce8f8ab3e8",
"Score": 1.0,
"State": 1
},
{
"Id": "008b8c68-8421-4f82-8c36-ecce8f8ab3e8",
"Score": 1.0,
"State": 1
}
],
"Surveys": [
{
"Id": "4747c712-f255-4ac2-916c-f4c5c15a9997",
"Questions": [
{
"Id": "94baff16-cfee-4439-bf78-b01d81666310",
"Answers": "sample string 2"
},
{
"Id": "94baff16-cfee-4439-bf78-b01d81666310",
"Answers": "sample string 2"
}
]
},
{
"Id": "4747c712-f255-4ac2-916c-f4c5c15a9997",
"Questions": [
{
"Id": "94baff16-cfee-4439-bf78-b01d81666310",
"Answers": "sample string 2"
},
{
"Id": "94baff16-cfee-4439-bf78-b01d81666310",
"Answers": "sample string 2"
}
]
}
],
"Sessions": [
{
"Id": "c802cb43-c140-4c4b-9c34-cc5a4955e0ed",
"ContentItemId": "efd32e99-d390-45fe-8907-09c208416821",
"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-17T22:06:38.3595612+00:00",
"RescheduleDate": "2026-08-17T22:06:38.3595612+00:00"
},
{
"Id": "c802cb43-c140-4c4b-9c34-cc5a4955e0ed",
"ContentItemId": "efd32e99-d390-45fe-8907-09c208416821",
"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-17T22:06:38.3595612+00:00",
"RescheduleDate": "2026-08-17T22:06:38.3595612+00:00"
}
],
"TotalRescheduleCount": 4,
"StudentLevelInfo": {
"StartLevel": "sample string 1",
"EndLevel": "sample string 2",
"CurrentLevel": "sample string 3"
}
}