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": "684562f6-ca61-4495-9ca5-2a2e40d1c24f",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-02-09T16:15:39.8621944+00:00",
  "Registration": [
    {
      "Id": "35fbbab7-fdfb-42c5-9fbe-a452586f064f",
      "UserId": "6f686ce2-8cb0-4c33-bd63-7f01f28c1a9d",
      "IsCurrent": true,
      "CenterId": "ab1a8b34-ac4e-46b9-b3e0-7aec60af73b4",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "f9d9ca20-bff7-46bb-bf2a-84c44b0ea105",
      "EndDate": "2026-02-09T16:15:39.8465532+00:00",
      "StartDate": "2026-02-09T16:15:39.8465532+00:00",
      "SchedulePreferenceDate": "2026-02-09T16:15:39.8465532+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": "35fbbab7-fdfb-42c5-9fbe-a452586f064f",
      "UserId": "6f686ce2-8cb0-4c33-bd63-7f01f28c1a9d",
      "IsCurrent": true,
      "CenterId": "ab1a8b34-ac4e-46b9-b3e0-7aec60af73b4",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "f9d9ca20-bff7-46bb-bf2a-84c44b0ea105",
      "EndDate": "2026-02-09T16:15:39.8465532+00:00",
      "StartDate": "2026-02-09T16:15:39.8465532+00:00",
      "SchedulePreferenceDate": "2026-02-09T16:15:39.8465532+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-02-09T16:15:39.8465532+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "f5bc23ed-d76b-4469-908f-e85e07956678",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "35dcd5ef-4bac-4815-8c34-2730215b65a5",
      "Sequence": 1,
      "AncestorCategoryId": "38011c70-7f24-40af-8948-c2780edda134",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "d4ab1d38-ff07-4490-a3a8-ef4f55c00de9",
          "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": "d4ab1d38-ff07-4490-a3a8-ef4f55c00de9",
          "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": "f5bc23ed-d76b-4469-908f-e85e07956678",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "35dcd5ef-4bac-4815-8c34-2730215b65a5",
      "Sequence": 1,
      "AncestorCategoryId": "38011c70-7f24-40af-8948-c2780edda134",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "d4ab1d38-ff07-4490-a3a8-ef4f55c00de9",
          "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": "d4ab1d38-ff07-4490-a3a8-ef4f55c00de9",
          "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": "f26965d5-ca7f-4ad3-830b-94b6f21888d7",
    "CategoryId": "6266a728-6683-40d0-abf6-a7bcde7aa397",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "6305f66b-c336-43fa-9c90-61dac47be1c8",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "6305f66b-c336-43fa-9c90-61dac47be1c8",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "b8dead00-8758-4072-9263-a71118f8de31",
      "Questions": [
        {
          "Id": "ab5a4079-b761-4d99-9b34-55653e4a27af",
          "Answers": "sample string 2"
        },
        {
          "Id": "ab5a4079-b761-4d99-9b34-55653e4a27af",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "b8dead00-8758-4072-9263-a71118f8de31",
      "Questions": [
        {
          "Id": "ab5a4079-b761-4d99-9b34-55653e4a27af",
          "Answers": "sample string 2"
        },
        {
          "Id": "ab5a4079-b761-4d99-9b34-55653e4a27af",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "a6407986-8251-4986-8290-1f1a0b1d69bb",
      "ContentItemId": "7d351ad7-4d94-43e6-8a87-7df40ae5447e",
      "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-02-09T16:15:39.8465532+00:00",
      "RescheduleDate": "2026-02-09T16:15:39.8465532+00:00"
    },
    {
      "Id": "a6407986-8251-4986-8290-1f1a0b1d69bb",
      "ContentItemId": "7d351ad7-4d94-43e6-8a87-7df40ae5447e",
      "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-02-09T16:15:39.8465532+00:00",
      "RescheduleDate": "2026-02-09T16:15:39.8465532+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": "684562f6-ca61-4495-9ca5-2a2e40d1c24f",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-02-09T16:15:39.987154+00:00",
  "Registration": [
    {
      "Id": "35fbbab7-fdfb-42c5-9fbe-a452586f064f",
      "UserId": "6f686ce2-8cb0-4c33-bd63-7f01f28c1a9d",
      "IsCurrent": true,
      "CenterId": "ab1a8b34-ac4e-46b9-b3e0-7aec60af73b4",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "f9d9ca20-bff7-46bb-bf2a-84c44b0ea105",
      "EndDate": "2026-02-09T16:15:39.8465532+00:00",
      "StartDate": "2026-02-09T16:15:39.8465532+00:00",
      "SchedulePreferenceDate": "2026-02-09T16:15:39.8465532+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": "35fbbab7-fdfb-42c5-9fbe-a452586f064f",
      "UserId": "6f686ce2-8cb0-4c33-bd63-7f01f28c1a9d",
      "IsCurrent": true,
      "CenterId": "ab1a8b34-ac4e-46b9-b3e0-7aec60af73b4",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "f9d9ca20-bff7-46bb-bf2a-84c44b0ea105",
      "EndDate": "2026-02-09T16:15:39.8465532+00:00",
      "StartDate": "2026-02-09T16:15:39.8465532+00:00",
      "SchedulePreferenceDate": "2026-02-09T16:15:39.8465532+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-02-09T16:15:39.8465532+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "f5bc23ed-d76b-4469-908f-e85e07956678",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "35dcd5ef-4bac-4815-8c34-2730215b65a5",
      "Sequence": 1,
      "AncestorCategoryId": "38011c70-7f24-40af-8948-c2780edda134",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "d4ab1d38-ff07-4490-a3a8-ef4f55c00de9",
          "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": "d4ab1d38-ff07-4490-a3a8-ef4f55c00de9",
          "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": "f5bc23ed-d76b-4469-908f-e85e07956678",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "35dcd5ef-4bac-4815-8c34-2730215b65a5",
      "Sequence": 1,
      "AncestorCategoryId": "38011c70-7f24-40af-8948-c2780edda134",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "d4ab1d38-ff07-4490-a3a8-ef4f55c00de9",
          "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": "d4ab1d38-ff07-4490-a3a8-ef4f55c00de9",
          "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": "f26965d5-ca7f-4ad3-830b-94b6f21888d7",
    "CategoryId": "6266a728-6683-40d0-abf6-a7bcde7aa397",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "6305f66b-c336-43fa-9c90-61dac47be1c8",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "6305f66b-c336-43fa-9c90-61dac47be1c8",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "b8dead00-8758-4072-9263-a71118f8de31",
      "Questions": [
        {
          "Id": "ab5a4079-b761-4d99-9b34-55653e4a27af",
          "Answers": "sample string 2"
        },
        {
          "Id": "ab5a4079-b761-4d99-9b34-55653e4a27af",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "b8dead00-8758-4072-9263-a71118f8de31",
      "Questions": [
        {
          "Id": "ab5a4079-b761-4d99-9b34-55653e4a27af",
          "Answers": "sample string 2"
        },
        {
          "Id": "ab5a4079-b761-4d99-9b34-55653e4a27af",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "a6407986-8251-4986-8290-1f1a0b1d69bb",
      "ContentItemId": "7d351ad7-4d94-43e6-8a87-7df40ae5447e",
      "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-02-09T16:15:39.8465532+00:00",
      "RescheduleDate": "2026-02-09T16:15:39.8465532+00:00"
    },
    {
      "Id": "a6407986-8251-4986-8290-1f1a0b1d69bb",
      "ContentItemId": "7d351ad7-4d94-43e6-8a87-7df40ae5447e",
      "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-02-09T16:15:39.8465532+00:00",
      "RescheduleDate": "2026-02-09T16:15:39.8465532+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}