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": "4eb2e739-9edc-4a44-ac9d-438b023f15db",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-08-03T14:06:53.2256706+00:00",
  "Registration": [
    {
      "Id": "5210ce12-c072-419c-9345-c97e3f8a2dfc",
      "UserId": "181ac4ca-3307-4db0-9ce4-c4f33ef48a1b",
      "IsCurrent": true,
      "CenterId": "84a45330-3637-4bc5-993e-54cd0038e4e2",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "f770fe87-66ea-4c37-8f9c-d83a21192f8e",
      "EndDate": "2026-08-03T14:06:53.2256706+00:00",
      "StartDate": "2026-08-03T14:06:53.2256706+00:00",
      "SchedulePreferenceDate": "2026-08-03T14:06:53.2256706+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": "5210ce12-c072-419c-9345-c97e3f8a2dfc",
      "UserId": "181ac4ca-3307-4db0-9ce4-c4f33ef48a1b",
      "IsCurrent": true,
      "CenterId": "84a45330-3637-4bc5-993e-54cd0038e4e2",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "f770fe87-66ea-4c37-8f9c-d83a21192f8e",
      "EndDate": "2026-08-03T14:06:53.2256706+00:00",
      "StartDate": "2026-08-03T14:06:53.2256706+00:00",
      "SchedulePreferenceDate": "2026-08-03T14:06:53.2256706+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-03T14:06:53.2256706+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "6f52a865-5623-440c-9314-f44a7a49c0c6",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "7780cca8-1941-42d5-b7ce-de0a4b8cc481",
      "Sequence": 1,
      "AncestorCategoryId": "d5c9ff2b-97d1-40d0-8a9d-f913413570c3",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "e0276fc6-acc4-4a7b-8490-b5227ea6d6f2",
          "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": "e0276fc6-acc4-4a7b-8490-b5227ea6d6f2",
          "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": "6f52a865-5623-440c-9314-f44a7a49c0c6",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "7780cca8-1941-42d5-b7ce-de0a4b8cc481",
      "Sequence": 1,
      "AncestorCategoryId": "d5c9ff2b-97d1-40d0-8a9d-f913413570c3",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "e0276fc6-acc4-4a7b-8490-b5227ea6d6f2",
          "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": "e0276fc6-acc4-4a7b-8490-b5227ea6d6f2",
          "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": "250fa24c-40d5-4c65-9a37-6318805e7cda",
    "CategoryId": "d586e743-2369-4747-a96a-961a18ab0890",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "a30ebe03-0c8c-4abf-a161-50f4b162e0c5",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "a30ebe03-0c8c-4abf-a161-50f4b162e0c5",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "f6459edc-1667-4c60-90b6-97577f50021d",
      "Questions": [
        {
          "Id": "c18fdee6-ab5a-42e5-ba07-3a24e6006aaf",
          "Answers": "sample string 2"
        },
        {
          "Id": "c18fdee6-ab5a-42e5-ba07-3a24e6006aaf",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "f6459edc-1667-4c60-90b6-97577f50021d",
      "Questions": [
        {
          "Id": "c18fdee6-ab5a-42e5-ba07-3a24e6006aaf",
          "Answers": "sample string 2"
        },
        {
          "Id": "c18fdee6-ab5a-42e5-ba07-3a24e6006aaf",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "43e63378-081d-4dab-8ef3-48fb7ad43d44",
      "ContentItemId": "03128014-746b-4b35-ae27-f06343fa0e51",
      "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-03T14:06:53.2256706+00:00",
      "RescheduleDate": "2026-08-03T14:06:53.2256706+00:00"
    },
    {
      "Id": "43e63378-081d-4dab-8ef3-48fb7ad43d44",
      "ContentItemId": "03128014-746b-4b35-ae27-f06343fa0e51",
      "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-03T14:06:53.2256706+00:00",
      "RescheduleDate": "2026-08-03T14:06:53.2256706+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": "4eb2e739-9edc-4a44-ac9d-438b023f15db",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-08-03T14:06:53.2725489+00:00",
  "Registration": [
    {
      "Id": "5210ce12-c072-419c-9345-c97e3f8a2dfc",
      "UserId": "181ac4ca-3307-4db0-9ce4-c4f33ef48a1b",
      "IsCurrent": true,
      "CenterId": "84a45330-3637-4bc5-993e-54cd0038e4e2",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "f770fe87-66ea-4c37-8f9c-d83a21192f8e",
      "EndDate": "2026-08-03T14:06:53.2256706+00:00",
      "StartDate": "2026-08-03T14:06:53.2256706+00:00",
      "SchedulePreferenceDate": "2026-08-03T14:06:53.2256706+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": "5210ce12-c072-419c-9345-c97e3f8a2dfc",
      "UserId": "181ac4ca-3307-4db0-9ce4-c4f33ef48a1b",
      "IsCurrent": true,
      "CenterId": "84a45330-3637-4bc5-993e-54cd0038e4e2",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "f770fe87-66ea-4c37-8f9c-d83a21192f8e",
      "EndDate": "2026-08-03T14:06:53.2256706+00:00",
      "StartDate": "2026-08-03T14:06:53.2256706+00:00",
      "SchedulePreferenceDate": "2026-08-03T14:06:53.2256706+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-03T14:06:53.2256706+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "6f52a865-5623-440c-9314-f44a7a49c0c6",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "7780cca8-1941-42d5-b7ce-de0a4b8cc481",
      "Sequence": 1,
      "AncestorCategoryId": "d5c9ff2b-97d1-40d0-8a9d-f913413570c3",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "e0276fc6-acc4-4a7b-8490-b5227ea6d6f2",
          "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": "e0276fc6-acc4-4a7b-8490-b5227ea6d6f2",
          "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": "6f52a865-5623-440c-9314-f44a7a49c0c6",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "7780cca8-1941-42d5-b7ce-de0a4b8cc481",
      "Sequence": 1,
      "AncestorCategoryId": "d5c9ff2b-97d1-40d0-8a9d-f913413570c3",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "e0276fc6-acc4-4a7b-8490-b5227ea6d6f2",
          "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": "e0276fc6-acc4-4a7b-8490-b5227ea6d6f2",
          "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": "250fa24c-40d5-4c65-9a37-6318805e7cda",
    "CategoryId": "d586e743-2369-4747-a96a-961a18ab0890",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "a30ebe03-0c8c-4abf-a161-50f4b162e0c5",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "a30ebe03-0c8c-4abf-a161-50f4b162e0c5",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "f6459edc-1667-4c60-90b6-97577f50021d",
      "Questions": [
        {
          "Id": "c18fdee6-ab5a-42e5-ba07-3a24e6006aaf",
          "Answers": "sample string 2"
        },
        {
          "Id": "c18fdee6-ab5a-42e5-ba07-3a24e6006aaf",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "f6459edc-1667-4c60-90b6-97577f50021d",
      "Questions": [
        {
          "Id": "c18fdee6-ab5a-42e5-ba07-3a24e6006aaf",
          "Answers": "sample string 2"
        },
        {
          "Id": "c18fdee6-ab5a-42e5-ba07-3a24e6006aaf",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "43e63378-081d-4dab-8ef3-48fb7ad43d44",
      "ContentItemId": "03128014-746b-4b35-ae27-f06343fa0e51",
      "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-03T14:06:53.2256706+00:00",
      "RescheduleDate": "2026-08-03T14:06:53.2256706+00:00"
    },
    {
      "Id": "43e63378-081d-4dab-8ef3-48fb7ad43d44",
      "ContentItemId": "03128014-746b-4b35-ae27-f06343fa0e51",
      "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-03T14:06:53.2256706+00:00",
      "RescheduleDate": "2026-08-03T14:06:53.2256706+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}