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": "ae70a08f-3539-42dc-9015-bcd090853f68",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-09-08T22:34:00.8858475+00:00",
  "Registration": {
    "Id": "eacb8ef4-e217-4951-bed3-350fd65d6b91",
    "UserId": "84b18fb1-b90a-48bd-9baf-d62a1c8dab1d",
    "IsCurrent": true,
    "CenterId": "dd9d87ec-9296-483f-9e16-57e5795f4248",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "0f18337c-e385-45d8-a1a0-9b1e19ba3a38",
    "EndDate": "2026-09-08T22:34:00.8858475+00:00",
    "StartDate": "2026-09-08T22:34:00.8858475+00:00",
    "SchedulePreferenceDate": "2026-09-08T22:34:00.8858475+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-09-08T22:34:00.8858475+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "aca1fd08-cbaa-4d0f-ae2a-41b0a7ef4fb6",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "83d53f2e-3586-4420-9c02-4f9aae4870f0",
      "Sequence": 1,
      "AncestorCategoryId": "c313273e-baf5-4244-8b07-fd2df6f6ae98",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "8cf751e8-22b3-406d-be34-ff47a4a21d9b",
          "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": "8cf751e8-22b3-406d-be34-ff47a4a21d9b",
          "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": "aca1fd08-cbaa-4d0f-ae2a-41b0a7ef4fb6",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "83d53f2e-3586-4420-9c02-4f9aae4870f0",
      "Sequence": 1,
      "AncestorCategoryId": "c313273e-baf5-4244-8b07-fd2df6f6ae98",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "8cf751e8-22b3-406d-be34-ff47a4a21d9b",
          "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": "8cf751e8-22b3-406d-be34-ff47a4a21d9b",
          "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": "d57674c3-9f2d-4702-9d44-12c2825d52be",
    "CategoryId": "7ea8562b-5314-4154-a86b-a65e5eb24208",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "15460c6c-6be6-4e90-b2cf-7222bd0f1782",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "15460c6c-6be6-4e90-b2cf-7222bd0f1782",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "41f2be3e-9e43-4e9b-a905-e4a027dd6b87",
      "Questions": [
        {
          "Id": "450bb9f2-b675-4186-b9e5-9fbc46449f10",
          "Answers": "sample string 2"
        },
        {
          "Id": "450bb9f2-b675-4186-b9e5-9fbc46449f10",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "41f2be3e-9e43-4e9b-a905-e4a027dd6b87",
      "Questions": [
        {
          "Id": "450bb9f2-b675-4186-b9e5-9fbc46449f10",
          "Answers": "sample string 2"
        },
        {
          "Id": "450bb9f2-b675-4186-b9e5-9fbc46449f10",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "73ce2679-2a0f-4da5-9cdc-42c41601abb9",
      "ContentItemId": "e70bcd86-1dee-4ab1-9339-6f3be3548be0",
      "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-09-08T22:34:00.8858475+00:00",
      "RescheduleDate": "2026-09-08T22:34:00.8858475+00:00"
    },
    {
      "Id": "73ce2679-2a0f-4da5-9cdc-42c41601abb9",
      "ContentItemId": "e70bcd86-1dee-4ab1-9339-6f3be3548be0",
      "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-09-08T22:34:00.8858475+00:00",
      "RescheduleDate": "2026-09-08T22:34:00.8858475+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}

text/json

Sample:
{
  "UserId": "ae70a08f-3539-42dc-9015-bcd090853f68",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-09-08T22:34:00.9327194+00:00",
  "Registration": {
    "Id": "eacb8ef4-e217-4951-bed3-350fd65d6b91",
    "UserId": "84b18fb1-b90a-48bd-9baf-d62a1c8dab1d",
    "IsCurrent": true,
    "CenterId": "dd9d87ec-9296-483f-9e16-57e5795f4248",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "0f18337c-e385-45d8-a1a0-9b1e19ba3a38",
    "EndDate": "2026-09-08T22:34:00.8858475+00:00",
    "StartDate": "2026-09-08T22:34:00.8858475+00:00",
    "SchedulePreferenceDate": "2026-09-08T22:34:00.8858475+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-09-08T22:34:00.8858475+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "aca1fd08-cbaa-4d0f-ae2a-41b0a7ef4fb6",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "83d53f2e-3586-4420-9c02-4f9aae4870f0",
      "Sequence": 1,
      "AncestorCategoryId": "c313273e-baf5-4244-8b07-fd2df6f6ae98",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "8cf751e8-22b3-406d-be34-ff47a4a21d9b",
          "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": "8cf751e8-22b3-406d-be34-ff47a4a21d9b",
          "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": "aca1fd08-cbaa-4d0f-ae2a-41b0a7ef4fb6",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "83d53f2e-3586-4420-9c02-4f9aae4870f0",
      "Sequence": 1,
      "AncestorCategoryId": "c313273e-baf5-4244-8b07-fd2df6f6ae98",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "8cf751e8-22b3-406d-be34-ff47a4a21d9b",
          "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": "8cf751e8-22b3-406d-be34-ff47a4a21d9b",
          "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": "d57674c3-9f2d-4702-9d44-12c2825d52be",
    "CategoryId": "7ea8562b-5314-4154-a86b-a65e5eb24208",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "15460c6c-6be6-4e90-b2cf-7222bd0f1782",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "15460c6c-6be6-4e90-b2cf-7222bd0f1782",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "41f2be3e-9e43-4e9b-a905-e4a027dd6b87",
      "Questions": [
        {
          "Id": "450bb9f2-b675-4186-b9e5-9fbc46449f10",
          "Answers": "sample string 2"
        },
        {
          "Id": "450bb9f2-b675-4186-b9e5-9fbc46449f10",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "41f2be3e-9e43-4e9b-a905-e4a027dd6b87",
      "Questions": [
        {
          "Id": "450bb9f2-b675-4186-b9e5-9fbc46449f10",
          "Answers": "sample string 2"
        },
        {
          "Id": "450bb9f2-b675-4186-b9e5-9fbc46449f10",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "73ce2679-2a0f-4da5-9cdc-42c41601abb9",
      "ContentItemId": "e70bcd86-1dee-4ab1-9339-6f3be3548be0",
      "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-09-08T22:34:00.8858475+00:00",
      "RescheduleDate": "2026-09-08T22:34:00.8858475+00:00"
    },
    {
      "Id": "73ce2679-2a0f-4da5-9cdc-42c41601abb9",
      "ContentItemId": "e70bcd86-1dee-4ab1-9339-6f3be3548be0",
      "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-09-08T22:34:00.8858475+00:00",
      "RescheduleDate": "2026-09-08T22:34:00.8858475+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}