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": "0c45dc35-60b5-4231-aa5c-7c123a9f4bea",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-08-13T23:04:44.5653515+00:00",
  "Registration": [
    {
      "Id": "c3c87e35-4b7c-4694-bf5b-c954f317371a",
      "UserId": "8129b481-f300-434b-a705-e3aa0c296b19",
      "IsCurrent": true,
      "CenterId": "9ca63281-e1fc-4d0e-9c1f-55212668acb7",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "f034ca8b-b1e6-4217-a8a1-db2eecb8aeff",
      "EndDate": "2026-08-13T23:04:44.5488812+00:00",
      "StartDate": "2026-08-13T23:04:44.5488812+00:00",
      "SchedulePreferenceDate": "2026-08-13T23:04:44.5488812+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": "c3c87e35-4b7c-4694-bf5b-c954f317371a",
      "UserId": "8129b481-f300-434b-a705-e3aa0c296b19",
      "IsCurrent": true,
      "CenterId": "9ca63281-e1fc-4d0e-9c1f-55212668acb7",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "f034ca8b-b1e6-4217-a8a1-db2eecb8aeff",
      "EndDate": "2026-08-13T23:04:44.5488812+00:00",
      "StartDate": "2026-08-13T23:04:44.5488812+00:00",
      "SchedulePreferenceDate": "2026-08-13T23:04:44.5488812+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-13T23:04:44.5488812+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "0803a94c-69b4-4aed-8cc5-da77c5be118c",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "51bf6f5f-e149-41f7-9140-d5d0855de84a",
      "Sequence": 1,
      "AncestorCategoryId": "ac6748cf-1780-4f01-8fcf-27c00eb3d8a9",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "a0a12459-d000-40c7-88ce-c861fb0451e9",
          "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": "a0a12459-d000-40c7-88ce-c861fb0451e9",
          "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": "0803a94c-69b4-4aed-8cc5-da77c5be118c",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "51bf6f5f-e149-41f7-9140-d5d0855de84a",
      "Sequence": 1,
      "AncestorCategoryId": "ac6748cf-1780-4f01-8fcf-27c00eb3d8a9",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "a0a12459-d000-40c7-88ce-c861fb0451e9",
          "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": "a0a12459-d000-40c7-88ce-c861fb0451e9",
          "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": "c1a27df6-3008-4f83-b4bf-49958b457a01",
    "CategoryId": "991ab1d0-f99b-48b5-a37e-443c84596695",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "31cfb98f-b591-423d-8098-3c414f804739",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "31cfb98f-b591-423d-8098-3c414f804739",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "e90f0fb1-e332-4d20-80c6-35fe8de3e9df",
      "Questions": [
        {
          "Id": "c5a51a94-8e99-4b13-bff3-a4809a11c9a1",
          "Answers": "sample string 2"
        },
        {
          "Id": "c5a51a94-8e99-4b13-bff3-a4809a11c9a1",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "e90f0fb1-e332-4d20-80c6-35fe8de3e9df",
      "Questions": [
        {
          "Id": "c5a51a94-8e99-4b13-bff3-a4809a11c9a1",
          "Answers": "sample string 2"
        },
        {
          "Id": "c5a51a94-8e99-4b13-bff3-a4809a11c9a1",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "cde36732-b025-4024-93eb-a35e6b0f19e9",
      "ContentItemId": "3dcb2ec4-890e-49ed-ac23-6a395b969315",
      "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-13T23:04:44.5488812+00:00",
      "RescheduleDate": "2026-08-13T23:04:44.5488812+00:00"
    },
    {
      "Id": "cde36732-b025-4024-93eb-a35e6b0f19e9",
      "ContentItemId": "3dcb2ec4-890e-49ed-ac23-6a395b969315",
      "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-13T23:04:44.5488812+00:00",
      "RescheduleDate": "2026-08-13T23:04:44.5488812+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": "0c45dc35-60b5-4231-aa5c-7c123a9f4bea",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-08-13T23:04:44.6582773+00:00",
  "Registration": [
    {
      "Id": "c3c87e35-4b7c-4694-bf5b-c954f317371a",
      "UserId": "8129b481-f300-434b-a705-e3aa0c296b19",
      "IsCurrent": true,
      "CenterId": "9ca63281-e1fc-4d0e-9c1f-55212668acb7",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "f034ca8b-b1e6-4217-a8a1-db2eecb8aeff",
      "EndDate": "2026-08-13T23:04:44.5488812+00:00",
      "StartDate": "2026-08-13T23:04:44.5488812+00:00",
      "SchedulePreferenceDate": "2026-08-13T23:04:44.5488812+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": "c3c87e35-4b7c-4694-bf5b-c954f317371a",
      "UserId": "8129b481-f300-434b-a705-e3aa0c296b19",
      "IsCurrent": true,
      "CenterId": "9ca63281-e1fc-4d0e-9c1f-55212668acb7",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "f034ca8b-b1e6-4217-a8a1-db2eecb8aeff",
      "EndDate": "2026-08-13T23:04:44.5488812+00:00",
      "StartDate": "2026-08-13T23:04:44.5488812+00:00",
      "SchedulePreferenceDate": "2026-08-13T23:04:44.5488812+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-13T23:04:44.5488812+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "0803a94c-69b4-4aed-8cc5-da77c5be118c",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "51bf6f5f-e149-41f7-9140-d5d0855de84a",
      "Sequence": 1,
      "AncestorCategoryId": "ac6748cf-1780-4f01-8fcf-27c00eb3d8a9",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "a0a12459-d000-40c7-88ce-c861fb0451e9",
          "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": "a0a12459-d000-40c7-88ce-c861fb0451e9",
          "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": "0803a94c-69b4-4aed-8cc5-da77c5be118c",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "51bf6f5f-e149-41f7-9140-d5d0855de84a",
      "Sequence": 1,
      "AncestorCategoryId": "ac6748cf-1780-4f01-8fcf-27c00eb3d8a9",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "a0a12459-d000-40c7-88ce-c861fb0451e9",
          "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": "a0a12459-d000-40c7-88ce-c861fb0451e9",
          "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": "c1a27df6-3008-4f83-b4bf-49958b457a01",
    "CategoryId": "991ab1d0-f99b-48b5-a37e-443c84596695",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "31cfb98f-b591-423d-8098-3c414f804739",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "31cfb98f-b591-423d-8098-3c414f804739",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "e90f0fb1-e332-4d20-80c6-35fe8de3e9df",
      "Questions": [
        {
          "Id": "c5a51a94-8e99-4b13-bff3-a4809a11c9a1",
          "Answers": "sample string 2"
        },
        {
          "Id": "c5a51a94-8e99-4b13-bff3-a4809a11c9a1",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "e90f0fb1-e332-4d20-80c6-35fe8de3e9df",
      "Questions": [
        {
          "Id": "c5a51a94-8e99-4b13-bff3-a4809a11c9a1",
          "Answers": "sample string 2"
        },
        {
          "Id": "c5a51a94-8e99-4b13-bff3-a4809a11c9a1",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "cde36732-b025-4024-93eb-a35e6b0f19e9",
      "ContentItemId": "3dcb2ec4-890e-49ed-ac23-6a395b969315",
      "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-13T23:04:44.5488812+00:00",
      "RescheduleDate": "2026-08-13T23:04:44.5488812+00:00"
    },
    {
      "Id": "cde36732-b025-4024-93eb-a35e6b0f19e9",
      "ContentItemId": "3dcb2ec4-890e-49ed-ac23-6a395b969315",
      "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-13T23:04:44.5488812+00:00",
      "RescheduleDate": "2026-08-13T23:04:44.5488812+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}