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": "414aa4ca-1973-43a6-a8fa-f96640d5474f",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-04-08T23:54:11.3461963+00:00",
  "Registration": {
    "Id": "a7bb6458-a16c-454a-9278-3d06ac0d8b4f",
    "UserId": "cfb00640-f88a-4754-88e4-6313403ebff1",
    "IsCurrent": true,
    "CenterId": "4b00adb3-129d-42f0-8103-a6cc78e0500d",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "2033ff93-2be2-44fe-bf47-4bd6a658db69",
    "EndDate": "2026-04-08T23:54:11.3461963+00:00",
    "StartDate": "2026-04-08T23:54:11.3461963+00:00",
    "SchedulePreferenceDate": "2026-04-08T23:54:11.3461963+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-08T23:54:11.3461963+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "848ab00b-9906-4bcc-9838-1fd5a8821728",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "5b556633-45b6-4c97-b6d9-62289f828fe9",
      "Sequence": 1,
      "AncestorCategoryId": "9e96a7a9-8626-4091-a3bd-b73e5f09b61b",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "8c595620-6cb4-4738-98f3-2b0f9bd88703",
          "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": "8c595620-6cb4-4738-98f3-2b0f9bd88703",
          "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": "848ab00b-9906-4bcc-9838-1fd5a8821728",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "5b556633-45b6-4c97-b6d9-62289f828fe9",
      "Sequence": 1,
      "AncestorCategoryId": "9e96a7a9-8626-4091-a3bd-b73e5f09b61b",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "8c595620-6cb4-4738-98f3-2b0f9bd88703",
          "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": "8c595620-6cb4-4738-98f3-2b0f9bd88703",
          "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": "419bcf82-b7af-4c04-b209-eddb5e981d11",
    "CategoryId": "df19b2c5-19b5-414b-850d-c828b470270b",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "8a53654c-72b1-42e2-a154-3328964253c9",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "8a53654c-72b1-42e2-a154-3328964253c9",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "e7fa2048-0c99-4273-b974-a5c35624fa18",
      "Questions": [
        {
          "Id": "c9b42dcc-4605-4b28-aae2-4b07a188313c",
          "Answers": "sample string 2"
        },
        {
          "Id": "c9b42dcc-4605-4b28-aae2-4b07a188313c",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "e7fa2048-0c99-4273-b974-a5c35624fa18",
      "Questions": [
        {
          "Id": "c9b42dcc-4605-4b28-aae2-4b07a188313c",
          "Answers": "sample string 2"
        },
        {
          "Id": "c9b42dcc-4605-4b28-aae2-4b07a188313c",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "fe570e61-9dc8-4ee9-b413-778fffdf81cd",
      "ContentItemId": "8f70adbe-8a97-4a17-8d97-4c8bc78161d0",
      "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-08T23:54:11.3461963+00:00",
      "RescheduleDate": "2026-04-08T23:54:11.3461963+00:00"
    },
    {
      "Id": "fe570e61-9dc8-4ee9-b413-778fffdf81cd",
      "ContentItemId": "8f70adbe-8a97-4a17-8d97-4c8bc78161d0",
      "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-08T23:54:11.3461963+00:00",
      "RescheduleDate": "2026-04-08T23:54:11.3461963+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}

text/json

Sample:
{
  "UserId": "414aa4ca-1973-43a6-a8fa-f96640d5474f",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-04-08T23:54:11.3774518+00:00",
  "Registration": {
    "Id": "a7bb6458-a16c-454a-9278-3d06ac0d8b4f",
    "UserId": "cfb00640-f88a-4754-88e4-6313403ebff1",
    "IsCurrent": true,
    "CenterId": "4b00adb3-129d-42f0-8103-a6cc78e0500d",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "2033ff93-2be2-44fe-bf47-4bd6a658db69",
    "EndDate": "2026-04-08T23:54:11.3461963+00:00",
    "StartDate": "2026-04-08T23:54:11.3461963+00:00",
    "SchedulePreferenceDate": "2026-04-08T23:54:11.3461963+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-08T23:54:11.3461963+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "848ab00b-9906-4bcc-9838-1fd5a8821728",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "5b556633-45b6-4c97-b6d9-62289f828fe9",
      "Sequence": 1,
      "AncestorCategoryId": "9e96a7a9-8626-4091-a3bd-b73e5f09b61b",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "8c595620-6cb4-4738-98f3-2b0f9bd88703",
          "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": "8c595620-6cb4-4738-98f3-2b0f9bd88703",
          "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": "848ab00b-9906-4bcc-9838-1fd5a8821728",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "5b556633-45b6-4c97-b6d9-62289f828fe9",
      "Sequence": 1,
      "AncestorCategoryId": "9e96a7a9-8626-4091-a3bd-b73e5f09b61b",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "8c595620-6cb4-4738-98f3-2b0f9bd88703",
          "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": "8c595620-6cb4-4738-98f3-2b0f9bd88703",
          "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": "419bcf82-b7af-4c04-b209-eddb5e981d11",
    "CategoryId": "df19b2c5-19b5-414b-850d-c828b470270b",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "8a53654c-72b1-42e2-a154-3328964253c9",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "8a53654c-72b1-42e2-a154-3328964253c9",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "e7fa2048-0c99-4273-b974-a5c35624fa18",
      "Questions": [
        {
          "Id": "c9b42dcc-4605-4b28-aae2-4b07a188313c",
          "Answers": "sample string 2"
        },
        {
          "Id": "c9b42dcc-4605-4b28-aae2-4b07a188313c",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "e7fa2048-0c99-4273-b974-a5c35624fa18",
      "Questions": [
        {
          "Id": "c9b42dcc-4605-4b28-aae2-4b07a188313c",
          "Answers": "sample string 2"
        },
        {
          "Id": "c9b42dcc-4605-4b28-aae2-4b07a188313c",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "fe570e61-9dc8-4ee9-b413-778fffdf81cd",
      "ContentItemId": "8f70adbe-8a97-4a17-8d97-4c8bc78161d0",
      "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-08T23:54:11.3461963+00:00",
      "RescheduleDate": "2026-04-08T23:54:11.3461963+00:00"
    },
    {
      "Id": "fe570e61-9dc8-4ee9-b413-778fffdf81cd",
      "ContentItemId": "8f70adbe-8a97-4a17-8d97-4c8bc78161d0",
      "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-08T23:54:11.3461963+00:00",
      "RescheduleDate": "2026-04-08T23:54:11.3461963+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}