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": "7f7d7344-ddf9-4a52-b3c3-477652a15f3b",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-07-04T14:25:18.1939171+00:00",
  "Registration": [
    {
      "Id": "265d025c-a176-42f6-b946-9122535e8b92",
      "UserId": "24fe2586-7c72-4c14-8909-95a88baec2de",
      "IsCurrent": true,
      "CenterId": "68eb4452-1b10-4072-be8f-b5f883e16382",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "0acd325e-cd21-4bc1-82ba-1a05a7288c4b",
      "EndDate": "2026-07-04T14:25:18.1782901+00:00",
      "StartDate": "2026-07-04T14:25:18.1782901+00:00",
      "SchedulePreferenceDate": "2026-07-04T14:25:18.1782901+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": "265d025c-a176-42f6-b946-9122535e8b92",
      "UserId": "24fe2586-7c72-4c14-8909-95a88baec2de",
      "IsCurrent": true,
      "CenterId": "68eb4452-1b10-4072-be8f-b5f883e16382",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "0acd325e-cd21-4bc1-82ba-1a05a7288c4b",
      "EndDate": "2026-07-04T14:25:18.1782901+00:00",
      "StartDate": "2026-07-04T14:25:18.1782901+00:00",
      "SchedulePreferenceDate": "2026-07-04T14:25:18.1782901+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-07-04T14:25:18.1782901+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "3a500570-5302-42b5-b70f-05bd65ff9d5b",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "9ddb210a-0e9f-4a23-8fe0-96f0c3bbb2ee",
      "Sequence": 1,
      "AncestorCategoryId": "cc0b400e-148b-4fdd-9a42-0d700b998202",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "cc13421f-84c1-4c6d-96ac-1877a81b41c7",
          "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": "cc13421f-84c1-4c6d-96ac-1877a81b41c7",
          "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": "3a500570-5302-42b5-b70f-05bd65ff9d5b",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "9ddb210a-0e9f-4a23-8fe0-96f0c3bbb2ee",
      "Sequence": 1,
      "AncestorCategoryId": "cc0b400e-148b-4fdd-9a42-0d700b998202",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "cc13421f-84c1-4c6d-96ac-1877a81b41c7",
          "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": "cc13421f-84c1-4c6d-96ac-1877a81b41c7",
          "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": "1ee5e1d8-90ec-4af5-aaa5-6a7855750938",
    "CategoryId": "82342883-0425-4ccd-8a56-3ee30ff7bcad",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "ee443320-5817-4516-9bdf-2b846b4d7947",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "ee443320-5817-4516-9bdf-2b846b4d7947",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "e7f30c52-b90a-4574-8990-c07eff9bf15f",
      "Questions": [
        {
          "Id": "a25dd037-9882-41bf-b53f-d16f3d4b7012",
          "Answers": "sample string 2"
        },
        {
          "Id": "a25dd037-9882-41bf-b53f-d16f3d4b7012",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "e7f30c52-b90a-4574-8990-c07eff9bf15f",
      "Questions": [
        {
          "Id": "a25dd037-9882-41bf-b53f-d16f3d4b7012",
          "Answers": "sample string 2"
        },
        {
          "Id": "a25dd037-9882-41bf-b53f-d16f3d4b7012",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "ba9c164c-5864-441a-8583-4cf25caf02cd",
      "ContentItemId": "1fc16e32-09ec-4806-8c90-5ec2fdf5fd65",
      "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-07-04T14:25:18.1782901+00:00",
      "RescheduleDate": "2026-07-04T14:25:18.1782901+00:00"
    },
    {
      "Id": "ba9c164c-5864-441a-8583-4cf25caf02cd",
      "ContentItemId": "1fc16e32-09ec-4806-8c90-5ec2fdf5fd65",
      "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-07-04T14:25:18.1782901+00:00",
      "RescheduleDate": "2026-07-04T14:25:18.1782901+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": "7f7d7344-ddf9-4a52-b3c3-477652a15f3b",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-07-04T14:25:18.2407912+00:00",
  "Registration": [
    {
      "Id": "265d025c-a176-42f6-b946-9122535e8b92",
      "UserId": "24fe2586-7c72-4c14-8909-95a88baec2de",
      "IsCurrent": true,
      "CenterId": "68eb4452-1b10-4072-be8f-b5f883e16382",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "0acd325e-cd21-4bc1-82ba-1a05a7288c4b",
      "EndDate": "2026-07-04T14:25:18.1782901+00:00",
      "StartDate": "2026-07-04T14:25:18.1782901+00:00",
      "SchedulePreferenceDate": "2026-07-04T14:25:18.1782901+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": "265d025c-a176-42f6-b946-9122535e8b92",
      "UserId": "24fe2586-7c72-4c14-8909-95a88baec2de",
      "IsCurrent": true,
      "CenterId": "68eb4452-1b10-4072-be8f-b5f883e16382",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "0acd325e-cd21-4bc1-82ba-1a05a7288c4b",
      "EndDate": "2026-07-04T14:25:18.1782901+00:00",
      "StartDate": "2026-07-04T14:25:18.1782901+00:00",
      "SchedulePreferenceDate": "2026-07-04T14:25:18.1782901+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-07-04T14:25:18.1782901+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "3a500570-5302-42b5-b70f-05bd65ff9d5b",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "9ddb210a-0e9f-4a23-8fe0-96f0c3bbb2ee",
      "Sequence": 1,
      "AncestorCategoryId": "cc0b400e-148b-4fdd-9a42-0d700b998202",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "cc13421f-84c1-4c6d-96ac-1877a81b41c7",
          "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": "cc13421f-84c1-4c6d-96ac-1877a81b41c7",
          "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": "3a500570-5302-42b5-b70f-05bd65ff9d5b",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "9ddb210a-0e9f-4a23-8fe0-96f0c3bbb2ee",
      "Sequence": 1,
      "AncestorCategoryId": "cc0b400e-148b-4fdd-9a42-0d700b998202",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "cc13421f-84c1-4c6d-96ac-1877a81b41c7",
          "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": "cc13421f-84c1-4c6d-96ac-1877a81b41c7",
          "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": "1ee5e1d8-90ec-4af5-aaa5-6a7855750938",
    "CategoryId": "82342883-0425-4ccd-8a56-3ee30ff7bcad",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "ee443320-5817-4516-9bdf-2b846b4d7947",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "ee443320-5817-4516-9bdf-2b846b4d7947",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "e7f30c52-b90a-4574-8990-c07eff9bf15f",
      "Questions": [
        {
          "Id": "a25dd037-9882-41bf-b53f-d16f3d4b7012",
          "Answers": "sample string 2"
        },
        {
          "Id": "a25dd037-9882-41bf-b53f-d16f3d4b7012",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "e7f30c52-b90a-4574-8990-c07eff9bf15f",
      "Questions": [
        {
          "Id": "a25dd037-9882-41bf-b53f-d16f3d4b7012",
          "Answers": "sample string 2"
        },
        {
          "Id": "a25dd037-9882-41bf-b53f-d16f3d4b7012",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "ba9c164c-5864-441a-8583-4cf25caf02cd",
      "ContentItemId": "1fc16e32-09ec-4806-8c90-5ec2fdf5fd65",
      "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-07-04T14:25:18.1782901+00:00",
      "RescheduleDate": "2026-07-04T14:25:18.1782901+00:00"
    },
    {
      "Id": "ba9c164c-5864-441a-8583-4cf25caf02cd",
      "ContentItemId": "1fc16e32-09ec-4806-8c90-5ec2fdf5fd65",
      "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-07-04T14:25:18.1782901+00:00",
      "RescheduleDate": "2026-07-04T14:25:18.1782901+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}