GET v2/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

NameDescriptionTypeAdditional information
userIdentifier

user's identifier

 PearsonEnglish.LearningServices.Business.Helpers.UserIdentifier

Required

Body Parameters

None.

Response Information

Resource Description

PearsonEnglish.LearningServices.Core.Models.View.UserStateViewModel
NameDescriptionTypeAdditional information
UserId

globally unique identifier

None.
IsNewUser

boolean

None.
UserName

string

None.
PrivacyPolicyApprove

boolean

None.
ServerTime

date

None.
Registration

Collection of 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.
StudentSpeakPlusLevelInfo

string

None.

Response Formats

application/json

Sample: 
{
  "UserId": "0eba6462-68e7-49aa-ad69-e39add537dd3",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-06-16T17:20:49.835089+00:00",
  "Registration": [
    {
      "Id": "d6a2e55e-5b4e-4ace-b34d-31e4ff245fc9",
      "UserId": "9e268f64-d2bc-4950-b4ad-ad1640186735",
      "IsCurrent": true,
      "CenterId": "24e0e959-11ff-4abe-b0a6-af468ead764d",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "4518caf9-0eee-4023-bfc2-81a5612502b3",
      "EndDate": "2026-06-16T17:20:49.8194617+00:00",
      "StartDate": "2026-06-16T17:20:49.8194617+00:00",
      "SchedulePreferenceDate": "2026-06-16T17:20:49.8194617+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"
    },
    {
      "Id": "d6a2e55e-5b4e-4ace-b34d-31e4ff245fc9",
      "UserId": "9e268f64-d2bc-4950-b4ad-ad1640186735",
      "IsCurrent": true,
      "CenterId": "24e0e959-11ff-4abe-b0a6-af468ead764d",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "4518caf9-0eee-4023-bfc2-81a5612502b3",
      "EndDate": "2026-06-16T17:20:49.8194617+00:00",
      "StartDate": "2026-06-16T17:20:49.8194617+00:00",
      "SchedulePreferenceDate": "2026-06-16T17:20:49.8194617+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-06-16T17:20:49.8194617+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "9dc398e4-ff46-42f5-ab76-ac694f77a031",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "d45150be-344a-4759-bcf7-cc7b3049b971",
      "Sequence": 1,
      "AncestorCategoryId": "ea028816-5397-498b-87ec-02bef976cbaa",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "78a7b7b2-f032-4666-ba8f-21fdf7da49c4",
          "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": "78a7b7b2-f032-4666-ba8f-21fdf7da49c4",
          "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": "9dc398e4-ff46-42f5-ab76-ac694f77a031",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "d45150be-344a-4759-bcf7-cc7b3049b971",
      "Sequence": 1,
      "AncestorCategoryId": "ea028816-5397-498b-87ec-02bef976cbaa",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "78a7b7b2-f032-4666-ba8f-21fdf7da49c4",
          "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": "78a7b7b2-f032-4666-ba8f-21fdf7da49c4",
          "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": "cb6f8441-71b7-4051-b7ff-66b14d76f56d",
    "CategoryId": "91f9e4c8-d527-49ed-b2c8-591882b70d9d",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "607428bd-aa37-4edc-8022-32137530450a",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "607428bd-aa37-4edc-8022-32137530450a",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "ea488983-55f6-4421-b27f-3750499ba66d",
      "Questions": [
        {
          "Id": "01dcc211-4909-4df7-ac0d-40a97cc3e168",
          "Answers": "sample string 2"
        },
        {
          "Id": "01dcc211-4909-4df7-ac0d-40a97cc3e168",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "ea488983-55f6-4421-b27f-3750499ba66d",
      "Questions": [
        {
          "Id": "01dcc211-4909-4df7-ac0d-40a97cc3e168",
          "Answers": "sample string 2"
        },
        {
          "Id": "01dcc211-4909-4df7-ac0d-40a97cc3e168",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "4a46b434-e6ff-47cd-a20c-f10a144aaca9",
      "ContentItemId": "8e4794be-8ca8-4c0e-8318-672b6f27a955",
      "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-06-16T17:20:49.8194617+00:00",
      "RescheduleDate": "2026-06-16T17:20:49.8194617+00:00"
    },
    {
      "Id": "4a46b434-e6ff-47cd-a20c-f10a144aaca9",
      "ContentItemId": "8e4794be-8ca8-4c0e-8318-672b6f27a955",
      "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-06-16T17:20:49.8194617+00:00",
      "RescheduleDate": "2026-06-16T17:20:49.8194617+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}

text/json

Sample: 
{
  "UserId": "0eba6462-68e7-49aa-ad69-e39add537dd3",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-06-16T17:20:49.8975889+00:00",
  "Registration": [
    {
      "Id": "d6a2e55e-5b4e-4ace-b34d-31e4ff245fc9",
      "UserId": "9e268f64-d2bc-4950-b4ad-ad1640186735",
      "IsCurrent": true,
      "CenterId": "24e0e959-11ff-4abe-b0a6-af468ead764d",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "4518caf9-0eee-4023-bfc2-81a5612502b3",
      "EndDate": "2026-06-16T17:20:49.8194617+00:00",
      "StartDate": "2026-06-16T17:20:49.8194617+00:00",
      "SchedulePreferenceDate": "2026-06-16T17:20:49.8194617+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"
    },
    {
      "Id": "d6a2e55e-5b4e-4ace-b34d-31e4ff245fc9",
      "UserId": "9e268f64-d2bc-4950-b4ad-ad1640186735",
      "IsCurrent": true,
      "CenterId": "24e0e959-11ff-4abe-b0a6-af468ead764d",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "4518caf9-0eee-4023-bfc2-81a5612502b3",
      "EndDate": "2026-06-16T17:20:49.8194617+00:00",
      "StartDate": "2026-06-16T17:20:49.8194617+00:00",
      "SchedulePreferenceDate": "2026-06-16T17:20:49.8194617+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-06-16T17:20:49.8194617+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "9dc398e4-ff46-42f5-ab76-ac694f77a031",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "d45150be-344a-4759-bcf7-cc7b3049b971",
      "Sequence": 1,
      "AncestorCategoryId": "ea028816-5397-498b-87ec-02bef976cbaa",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "78a7b7b2-f032-4666-ba8f-21fdf7da49c4",
          "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": "78a7b7b2-f032-4666-ba8f-21fdf7da49c4",
          "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": "9dc398e4-ff46-42f5-ab76-ac694f77a031",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "d45150be-344a-4759-bcf7-cc7b3049b971",
      "Sequence": 1,
      "AncestorCategoryId": "ea028816-5397-498b-87ec-02bef976cbaa",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "78a7b7b2-f032-4666-ba8f-21fdf7da49c4",
          "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": "78a7b7b2-f032-4666-ba8f-21fdf7da49c4",
          "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": "cb6f8441-71b7-4051-b7ff-66b14d76f56d",
    "CategoryId": "91f9e4c8-d527-49ed-b2c8-591882b70d9d",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "607428bd-aa37-4edc-8022-32137530450a",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "607428bd-aa37-4edc-8022-32137530450a",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "ea488983-55f6-4421-b27f-3750499ba66d",
      "Questions": [
        {
          "Id": "01dcc211-4909-4df7-ac0d-40a97cc3e168",
          "Answers": "sample string 2"
        },
        {
          "Id": "01dcc211-4909-4df7-ac0d-40a97cc3e168",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "ea488983-55f6-4421-b27f-3750499ba66d",
      "Questions": [
        {
          "Id": "01dcc211-4909-4df7-ac0d-40a97cc3e168",
          "Answers": "sample string 2"
        },
        {
          "Id": "01dcc211-4909-4df7-ac0d-40a97cc3e168",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "4a46b434-e6ff-47cd-a20c-f10a144aaca9",
      "ContentItemId": "8e4794be-8ca8-4c0e-8318-672b6f27a955",
      "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-06-16T17:20:49.8194617+00:00",
      "RescheduleDate": "2026-06-16T17:20:49.8194617+00:00"
    },
    {
      "Id": "4a46b434-e6ff-47cd-a20c-f10a144aaca9",
      "ContentItemId": "8e4794be-8ca8-4c0e-8318-672b6f27a955",
      "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-06-16T17:20:49.8194617+00:00",
      "RescheduleDate": "2026-06-16T17:20:49.8194617+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}