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": "d3168507-4160-421c-a9f5-5912c391b253",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-04-18T08:04:22.4320418+00:00",
  "Registration": [
    {
      "Id": "9ebc56a6-d4de-4114-ab10-b3a507d11a65",
      "UserId": "08dbf5a5-45c0-4e69-b947-d79724182a0f",
      "IsCurrent": true,
      "CenterId": "5a454779-c0a7-4ebb-946e-79d3148bdd7d",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "b9fd6f0d-7081-4322-8359-2e47db74567d",
      "EndDate": "2026-04-18T08:04:22.4320418+00:00",
      "StartDate": "2026-04-18T08:04:22.4320418+00:00",
      "SchedulePreferenceDate": "2026-04-18T08:04:22.4320418+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": "9ebc56a6-d4de-4114-ab10-b3a507d11a65",
      "UserId": "08dbf5a5-45c0-4e69-b947-d79724182a0f",
      "IsCurrent": true,
      "CenterId": "5a454779-c0a7-4ebb-946e-79d3148bdd7d",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "b9fd6f0d-7081-4322-8359-2e47db74567d",
      "EndDate": "2026-04-18T08:04:22.4320418+00:00",
      "StartDate": "2026-04-18T08:04:22.4320418+00:00",
      "SchedulePreferenceDate": "2026-04-18T08:04:22.4320418+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-04-18T08:04:22.4320418+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "571905e3-f520-4bb2-8ebd-863da80462d6",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "a4f6a359-497b-4b67-8e11-d72939b62ff4",
      "Sequence": 1,
      "AncestorCategoryId": "3c69dbe3-6e54-4fa0-bf0b-4655036945e4",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "866d0934-34e0-4c82-92e0-9c7eff8723a5",
          "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": "866d0934-34e0-4c82-92e0-9c7eff8723a5",
          "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": "571905e3-f520-4bb2-8ebd-863da80462d6",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "a4f6a359-497b-4b67-8e11-d72939b62ff4",
      "Sequence": 1,
      "AncestorCategoryId": "3c69dbe3-6e54-4fa0-bf0b-4655036945e4",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "866d0934-34e0-4c82-92e0-9c7eff8723a5",
          "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": "866d0934-34e0-4c82-92e0-9c7eff8723a5",
          "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": "56ef3d2c-32ee-4bc3-9cba-1971d8ec91d1",
    "CategoryId": "e7caf0bb-8029-419d-ae19-2c4e5bdace91",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "da508bce-2b9a-451f-b834-51529d35f588",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "da508bce-2b9a-451f-b834-51529d35f588",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "d8fea104-618a-4708-bd36-40454557bff5",
      "Questions": [
        {
          "Id": "48cfdcb6-1d82-4396-909c-3f1888a22d82",
          "Answers": "sample string 2"
        },
        {
          "Id": "48cfdcb6-1d82-4396-909c-3f1888a22d82",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "d8fea104-618a-4708-bd36-40454557bff5",
      "Questions": [
        {
          "Id": "48cfdcb6-1d82-4396-909c-3f1888a22d82",
          "Answers": "sample string 2"
        },
        {
          "Id": "48cfdcb6-1d82-4396-909c-3f1888a22d82",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "580ca091-441d-46de-93d0-3f76ee67f361",
      "ContentItemId": "b676ea9c-88ad-4885-ab95-35d7509c9bf6",
      "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-04-18T08:04:22.4320418+00:00",
      "RescheduleDate": "2026-04-18T08:04:22.4320418+00:00"
    },
    {
      "Id": "580ca091-441d-46de-93d0-3f76ee67f361",
      "ContentItemId": "b676ea9c-88ad-4885-ab95-35d7509c9bf6",
      "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-04-18T08:04:22.4320418+00:00",
      "RescheduleDate": "2026-04-18T08:04:22.4320418+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": "d3168507-4160-421c-a9f5-5912c391b253",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-04-18T08:04:22.4789169+00:00",
  "Registration": [
    {
      "Id": "9ebc56a6-d4de-4114-ab10-b3a507d11a65",
      "UserId": "08dbf5a5-45c0-4e69-b947-d79724182a0f",
      "IsCurrent": true,
      "CenterId": "5a454779-c0a7-4ebb-946e-79d3148bdd7d",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "b9fd6f0d-7081-4322-8359-2e47db74567d",
      "EndDate": "2026-04-18T08:04:22.4320418+00:00",
      "StartDate": "2026-04-18T08:04:22.4320418+00:00",
      "SchedulePreferenceDate": "2026-04-18T08:04:22.4320418+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": "9ebc56a6-d4de-4114-ab10-b3a507d11a65",
      "UserId": "08dbf5a5-45c0-4e69-b947-d79724182a0f",
      "IsCurrent": true,
      "CenterId": "5a454779-c0a7-4ebb-946e-79d3148bdd7d",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "b9fd6f0d-7081-4322-8359-2e47db74567d",
      "EndDate": "2026-04-18T08:04:22.4320418+00:00",
      "StartDate": "2026-04-18T08:04:22.4320418+00:00",
      "SchedulePreferenceDate": "2026-04-18T08:04:22.4320418+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-04-18T08:04:22.4320418+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "571905e3-f520-4bb2-8ebd-863da80462d6",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "a4f6a359-497b-4b67-8e11-d72939b62ff4",
      "Sequence": 1,
      "AncestorCategoryId": "3c69dbe3-6e54-4fa0-bf0b-4655036945e4",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "866d0934-34e0-4c82-92e0-9c7eff8723a5",
          "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": "866d0934-34e0-4c82-92e0-9c7eff8723a5",
          "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": "571905e3-f520-4bb2-8ebd-863da80462d6",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "a4f6a359-497b-4b67-8e11-d72939b62ff4",
      "Sequence": 1,
      "AncestorCategoryId": "3c69dbe3-6e54-4fa0-bf0b-4655036945e4",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "866d0934-34e0-4c82-92e0-9c7eff8723a5",
          "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": "866d0934-34e0-4c82-92e0-9c7eff8723a5",
          "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": "56ef3d2c-32ee-4bc3-9cba-1971d8ec91d1",
    "CategoryId": "e7caf0bb-8029-419d-ae19-2c4e5bdace91",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "da508bce-2b9a-451f-b834-51529d35f588",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "da508bce-2b9a-451f-b834-51529d35f588",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "d8fea104-618a-4708-bd36-40454557bff5",
      "Questions": [
        {
          "Id": "48cfdcb6-1d82-4396-909c-3f1888a22d82",
          "Answers": "sample string 2"
        },
        {
          "Id": "48cfdcb6-1d82-4396-909c-3f1888a22d82",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "d8fea104-618a-4708-bd36-40454557bff5",
      "Questions": [
        {
          "Id": "48cfdcb6-1d82-4396-909c-3f1888a22d82",
          "Answers": "sample string 2"
        },
        {
          "Id": "48cfdcb6-1d82-4396-909c-3f1888a22d82",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "580ca091-441d-46de-93d0-3f76ee67f361",
      "ContentItemId": "b676ea9c-88ad-4885-ab95-35d7509c9bf6",
      "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-04-18T08:04:22.4320418+00:00",
      "RescheduleDate": "2026-04-18T08:04:22.4320418+00:00"
    },
    {
      "Id": "580ca091-441d-46de-93d0-3f76ee67f361",
      "ContentItemId": "b676ea9c-88ad-4885-ab95-35d7509c9bf6",
      "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-04-18T08:04:22.4320418+00:00",
      "RescheduleDate": "2026-04-18T08:04:22.4320418+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}