GET 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.Views.UserStateBackwardCompatibleViewModel
NameDescriptionTypeAdditional information
UserId

globally unique identifier

None.

IsNewUser

boolean

None.

UserName

string

None.

PrivacyPolicyApprove

boolean

None.

ServerTime

date

None.

Registration

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.

Response Formats

application/json

Sample:
{
  "UserId": "66799e6d-8354-46b7-a73f-8da5471b49ff",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-07-23T15:11:45.4144868+00:00",
  "Registration": {
    "Id": "1213a606-7bca-46e3-bb8c-b3ba4fa582af",
    "UserId": "03ddd2b0-463c-4eff-a634-fb3c9061fd62",
    "IsCurrent": true,
    "CenterId": "50646454-3879-46b1-a2eb-87bbe18e2453",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "1ce91fe4-8146-467f-a020-19932762defe",
    "EndDate": "2026-07-23T15:11:45.3988564+00:00",
    "StartDate": "2026-07-23T15:11:45.3988564+00:00",
    "SchedulePreferenceDate": "2026-07-23T15:11:45.3988564+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-23T15:11:45.3988564+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "9262c37c-3c04-446b-9a6e-869f0cdffba7",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "8b3d7703-35f7-44b7-95c9-61e3a2bba15c",
      "Sequence": 1,
      "AncestorCategoryId": "0501b98d-683e-4859-96ed-89686579aa47",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "5f9a0ff9-b139-48b8-9574-d37467b0c6b5",
          "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": "5f9a0ff9-b139-48b8-9574-d37467b0c6b5",
          "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": "9262c37c-3c04-446b-9a6e-869f0cdffba7",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "8b3d7703-35f7-44b7-95c9-61e3a2bba15c",
      "Sequence": 1,
      "AncestorCategoryId": "0501b98d-683e-4859-96ed-89686579aa47",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "5f9a0ff9-b139-48b8-9574-d37467b0c6b5",
          "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": "5f9a0ff9-b139-48b8-9574-d37467b0c6b5",
          "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": "77332556-c6fe-4465-9fde-cde819bcba87",
    "CategoryId": "758ecf12-f1c7-4b5d-92a1-aa5f1d526875",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "c109efa4-47df-4ccc-8edc-4beabbe48eb6",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "c109efa4-47df-4ccc-8edc-4beabbe48eb6",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "c34533cb-1f2e-401f-ac65-caea6b3061de",
      "Questions": [
        {
          "Id": "5b0183e9-a48d-4114-bf81-c12ff63d63d3",
          "Answers": "sample string 2"
        },
        {
          "Id": "5b0183e9-a48d-4114-bf81-c12ff63d63d3",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "c34533cb-1f2e-401f-ac65-caea6b3061de",
      "Questions": [
        {
          "Id": "5b0183e9-a48d-4114-bf81-c12ff63d63d3",
          "Answers": "sample string 2"
        },
        {
          "Id": "5b0183e9-a48d-4114-bf81-c12ff63d63d3",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "fe2bb2d9-ac37-4abe-9fbf-1194d1ad3f10",
      "ContentItemId": "213b6b94-1ec2-4ccb-8f54-2530a2cb4b32",
      "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-23T15:11:45.4144868+00:00",
      "RescheduleDate": "2026-07-23T15:11:45.4144868+00:00"
    },
    {
      "Id": "fe2bb2d9-ac37-4abe-9fbf-1194d1ad3f10",
      "ContentItemId": "213b6b94-1ec2-4ccb-8f54-2530a2cb4b32",
      "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-23T15:11:45.4144868+00:00",
      "RescheduleDate": "2026-07-23T15:11:45.4144868+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}

text/json

Sample:
{
  "UserId": "66799e6d-8354-46b7-a73f-8da5471b49ff",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-07-23T15:11:45.4457374+00:00",
  "Registration": {
    "Id": "1213a606-7bca-46e3-bb8c-b3ba4fa582af",
    "UserId": "03ddd2b0-463c-4eff-a634-fb3c9061fd62",
    "IsCurrent": true,
    "CenterId": "50646454-3879-46b1-a2eb-87bbe18e2453",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "1ce91fe4-8146-467f-a020-19932762defe",
    "EndDate": "2026-07-23T15:11:45.3988564+00:00",
    "StartDate": "2026-07-23T15:11:45.3988564+00:00",
    "SchedulePreferenceDate": "2026-07-23T15:11:45.3988564+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-23T15:11:45.3988564+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "9262c37c-3c04-446b-9a6e-869f0cdffba7",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "8b3d7703-35f7-44b7-95c9-61e3a2bba15c",
      "Sequence": 1,
      "AncestorCategoryId": "0501b98d-683e-4859-96ed-89686579aa47",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "5f9a0ff9-b139-48b8-9574-d37467b0c6b5",
          "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": "5f9a0ff9-b139-48b8-9574-d37467b0c6b5",
          "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": "9262c37c-3c04-446b-9a6e-869f0cdffba7",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "8b3d7703-35f7-44b7-95c9-61e3a2bba15c",
      "Sequence": 1,
      "AncestorCategoryId": "0501b98d-683e-4859-96ed-89686579aa47",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "5f9a0ff9-b139-48b8-9574-d37467b0c6b5",
          "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": "5f9a0ff9-b139-48b8-9574-d37467b0c6b5",
          "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": "77332556-c6fe-4465-9fde-cde819bcba87",
    "CategoryId": "758ecf12-f1c7-4b5d-92a1-aa5f1d526875",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "c109efa4-47df-4ccc-8edc-4beabbe48eb6",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "c109efa4-47df-4ccc-8edc-4beabbe48eb6",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "c34533cb-1f2e-401f-ac65-caea6b3061de",
      "Questions": [
        {
          "Id": "5b0183e9-a48d-4114-bf81-c12ff63d63d3",
          "Answers": "sample string 2"
        },
        {
          "Id": "5b0183e9-a48d-4114-bf81-c12ff63d63d3",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "c34533cb-1f2e-401f-ac65-caea6b3061de",
      "Questions": [
        {
          "Id": "5b0183e9-a48d-4114-bf81-c12ff63d63d3",
          "Answers": "sample string 2"
        },
        {
          "Id": "5b0183e9-a48d-4114-bf81-c12ff63d63d3",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "fe2bb2d9-ac37-4abe-9fbf-1194d1ad3f10",
      "ContentItemId": "213b6b94-1ec2-4ccb-8f54-2530a2cb4b32",
      "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-23T15:11:45.4144868+00:00",
      "RescheduleDate": "2026-07-23T15:11:45.4144868+00:00"
    },
    {
      "Id": "fe2bb2d9-ac37-4abe-9fbf-1194d1ad3f10",
      "ContentItemId": "213b6b94-1ec2-4ccb-8f54-2530a2cb4b32",
      "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-23T15:11:45.4144868+00:00",
      "RescheduleDate": "2026-07-23T15:11:45.4144868+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}