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": "56fa0566-8a66-433b-8293-5f7a5979f9d0",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-07-30T08:43:21.2755688+00:00",
  "Registration": {
    "Id": "5dd9814f-2b67-477a-8043-2450a4f6471c",
    "UserId": "e97dc26b-22d4-4ef6-bb5d-d97376def2f3",
    "IsCurrent": true,
    "CenterId": "0d7a6e53-0de3-4d25-961c-d7bcc091038a",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "beb6bb98-5042-4193-a462-ecc847e4fa99",
    "EndDate": "2026-07-30T08:43:21.2599458+00:00",
    "StartDate": "2026-07-30T08:43:21.2599458+00:00",
    "SchedulePreferenceDate": "2026-07-30T08:43:21.2599458+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-30T08:43:21.2599458+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "f9a3d311-1445-48db-a5d4-3fbb115dfac5",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "31a01c26-7aba-4c77-b919-15a06ccd203e",
      "Sequence": 1,
      "AncestorCategoryId": "1ee64a1a-4900-469a-8960-bd4ea4b95848",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "425017d7-dc22-4e1d-8f22-c22c17a30e93",
          "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": "425017d7-dc22-4e1d-8f22-c22c17a30e93",
          "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": "f9a3d311-1445-48db-a5d4-3fbb115dfac5",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "31a01c26-7aba-4c77-b919-15a06ccd203e",
      "Sequence": 1,
      "AncestorCategoryId": "1ee64a1a-4900-469a-8960-bd4ea4b95848",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "425017d7-dc22-4e1d-8f22-c22c17a30e93",
          "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": "425017d7-dc22-4e1d-8f22-c22c17a30e93",
          "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": "097590c7-70fa-40d7-b368-fa889b7ee357",
    "CategoryId": "e84913c2-6379-44b1-a5c3-499ed741908d",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "64e29b2a-bfaa-4129-bc1d-d89d17cc05c4",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "64e29b2a-bfaa-4129-bc1d-d89d17cc05c4",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "afa463b7-d2d6-4fb1-9059-54afdc7af629",
      "Questions": [
        {
          "Id": "53765f3b-980d-4651-97fe-ba537795aeea",
          "Answers": "sample string 2"
        },
        {
          "Id": "53765f3b-980d-4651-97fe-ba537795aeea",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "afa463b7-d2d6-4fb1-9059-54afdc7af629",
      "Questions": [
        {
          "Id": "53765f3b-980d-4651-97fe-ba537795aeea",
          "Answers": "sample string 2"
        },
        {
          "Id": "53765f3b-980d-4651-97fe-ba537795aeea",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "22c218cf-d6c5-4eca-b49a-309bf59fc2bf",
      "ContentItemId": "dde9a505-c065-4cc7-9750-5514c80d68e4",
      "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-30T08:43:21.2599458+00:00",
      "RescheduleDate": "2026-07-30T08:43:21.2599458+00:00"
    },
    {
      "Id": "22c218cf-d6c5-4eca-b49a-309bf59fc2bf",
      "ContentItemId": "dde9a505-c065-4cc7-9750-5514c80d68e4",
      "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-30T08:43:21.2599458+00:00",
      "RescheduleDate": "2026-07-30T08:43:21.2599458+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}

text/json

Sample:
{
  "UserId": "56fa0566-8a66-433b-8293-5f7a5979f9d0",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-07-30T08:43:21.3224452+00:00",
  "Registration": {
    "Id": "5dd9814f-2b67-477a-8043-2450a4f6471c",
    "UserId": "e97dc26b-22d4-4ef6-bb5d-d97376def2f3",
    "IsCurrent": true,
    "CenterId": "0d7a6e53-0de3-4d25-961c-d7bcc091038a",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "beb6bb98-5042-4193-a462-ecc847e4fa99",
    "EndDate": "2026-07-30T08:43:21.2599458+00:00",
    "StartDate": "2026-07-30T08:43:21.2599458+00:00",
    "SchedulePreferenceDate": "2026-07-30T08:43:21.2599458+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-30T08:43:21.2599458+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "f9a3d311-1445-48db-a5d4-3fbb115dfac5",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "31a01c26-7aba-4c77-b919-15a06ccd203e",
      "Sequence": 1,
      "AncestorCategoryId": "1ee64a1a-4900-469a-8960-bd4ea4b95848",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "425017d7-dc22-4e1d-8f22-c22c17a30e93",
          "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": "425017d7-dc22-4e1d-8f22-c22c17a30e93",
          "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": "f9a3d311-1445-48db-a5d4-3fbb115dfac5",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "31a01c26-7aba-4c77-b919-15a06ccd203e",
      "Sequence": 1,
      "AncestorCategoryId": "1ee64a1a-4900-469a-8960-bd4ea4b95848",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "425017d7-dc22-4e1d-8f22-c22c17a30e93",
          "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": "425017d7-dc22-4e1d-8f22-c22c17a30e93",
          "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": "097590c7-70fa-40d7-b368-fa889b7ee357",
    "CategoryId": "e84913c2-6379-44b1-a5c3-499ed741908d",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "64e29b2a-bfaa-4129-bc1d-d89d17cc05c4",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "64e29b2a-bfaa-4129-bc1d-d89d17cc05c4",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "afa463b7-d2d6-4fb1-9059-54afdc7af629",
      "Questions": [
        {
          "Id": "53765f3b-980d-4651-97fe-ba537795aeea",
          "Answers": "sample string 2"
        },
        {
          "Id": "53765f3b-980d-4651-97fe-ba537795aeea",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "afa463b7-d2d6-4fb1-9059-54afdc7af629",
      "Questions": [
        {
          "Id": "53765f3b-980d-4651-97fe-ba537795aeea",
          "Answers": "sample string 2"
        },
        {
          "Id": "53765f3b-980d-4651-97fe-ba537795aeea",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "22c218cf-d6c5-4eca-b49a-309bf59fc2bf",
      "ContentItemId": "dde9a505-c065-4cc7-9750-5514c80d68e4",
      "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-30T08:43:21.2599458+00:00",
      "RescheduleDate": "2026-07-30T08:43:21.2599458+00:00"
    },
    {
      "Id": "22c218cf-d6c5-4eca-b49a-309bf59fc2bf",
      "ContentItemId": "dde9a505-c065-4cc7-9750-5514c80d68e4",
      "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-30T08:43:21.2599458+00:00",
      "RescheduleDate": "2026-07-30T08:43:21.2599458+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}