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": "ca006264-b3b1-4825-add7-facb8bce51f3",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-11-17T07:40:56.2111393+00:00",
  "Registration": {
    "Id": "2c110cfa-53ea-4c8e-abd7-922181b73212",
    "UserId": "8c10b1ba-3de3-4a38-b97d-dc42adb97969",
    "IsCurrent": true,
    "CenterId": "bbffed90-c915-467f-81da-2fe888ae525c",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "b42a3d48-62c9-44aa-bacf-3ad88b875812",
    "EndDate": "2026-11-17T07:40:56.1955029+00:00",
    "StartDate": "2026-11-17T07:40:56.1955029+00:00",
    "SchedulePreferenceDate": "2026-11-17T07:40:56.1955029+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-11-17T07:40:56.1955029+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "53871a7f-3973-4608-91a5-b132809647f5",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "e0d26383-1b9d-49ad-a0bd-96238fa012e9",
      "Sequence": 1,
      "AncestorCategoryId": "03cdaf51-edbd-4422-9362-f64c5f6f6b51",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "e02dff55-50fc-4abb-bd2e-2986c66d07c9",
          "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": "e02dff55-50fc-4abb-bd2e-2986c66d07c9",
          "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": "53871a7f-3973-4608-91a5-b132809647f5",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "e0d26383-1b9d-49ad-a0bd-96238fa012e9",
      "Sequence": 1,
      "AncestorCategoryId": "03cdaf51-edbd-4422-9362-f64c5f6f6b51",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "e02dff55-50fc-4abb-bd2e-2986c66d07c9",
          "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": "e02dff55-50fc-4abb-bd2e-2986c66d07c9",
          "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": "d0fe3f71-9b6e-4d9b-b9cb-94915227ef02",
    "CategoryId": "0486571b-b2f0-4ce4-8143-25e18c2574fe",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "e6b02acb-d48e-48a9-be7b-fbf79f834691",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "e6b02acb-d48e-48a9-be7b-fbf79f834691",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "9f4d7edb-e39e-4684-9f1a-05355092803a",
      "Questions": [
        {
          "Id": "26bc7e04-0349-43e1-ba5c-8b659e8a5793",
          "Answers": "sample string 2"
        },
        {
          "Id": "26bc7e04-0349-43e1-ba5c-8b659e8a5793",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "9f4d7edb-e39e-4684-9f1a-05355092803a",
      "Questions": [
        {
          "Id": "26bc7e04-0349-43e1-ba5c-8b659e8a5793",
          "Answers": "sample string 2"
        },
        {
          "Id": "26bc7e04-0349-43e1-ba5c-8b659e8a5793",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "bf8a9d10-61f6-46bf-8540-8020d3bebc2c",
      "ContentItemId": "a8d819af-1409-4b8f-afa3-09949eeec112",
      "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-11-17T07:40:56.2111393+00:00",
      "RescheduleDate": "2026-11-17T07:40:56.2111393+00:00"
    },
    {
      "Id": "bf8a9d10-61f6-46bf-8540-8020d3bebc2c",
      "ContentItemId": "a8d819af-1409-4b8f-afa3-09949eeec112",
      "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-11-17T07:40:56.2111393+00:00",
      "RescheduleDate": "2026-11-17T07:40:56.2111393+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}

text/json

Sample:
{
  "UserId": "ca006264-b3b1-4825-add7-facb8bce51f3",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-11-17T07:40:56.2423784+00:00",
  "Registration": {
    "Id": "2c110cfa-53ea-4c8e-abd7-922181b73212",
    "UserId": "8c10b1ba-3de3-4a38-b97d-dc42adb97969",
    "IsCurrent": true,
    "CenterId": "bbffed90-c915-467f-81da-2fe888ae525c",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "b42a3d48-62c9-44aa-bacf-3ad88b875812",
    "EndDate": "2026-11-17T07:40:56.1955029+00:00",
    "StartDate": "2026-11-17T07:40:56.1955029+00:00",
    "SchedulePreferenceDate": "2026-11-17T07:40:56.1955029+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-11-17T07:40:56.1955029+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "53871a7f-3973-4608-91a5-b132809647f5",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "e0d26383-1b9d-49ad-a0bd-96238fa012e9",
      "Sequence": 1,
      "AncestorCategoryId": "03cdaf51-edbd-4422-9362-f64c5f6f6b51",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "e02dff55-50fc-4abb-bd2e-2986c66d07c9",
          "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": "e02dff55-50fc-4abb-bd2e-2986c66d07c9",
          "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": "53871a7f-3973-4608-91a5-b132809647f5",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "e0d26383-1b9d-49ad-a0bd-96238fa012e9",
      "Sequence": 1,
      "AncestorCategoryId": "03cdaf51-edbd-4422-9362-f64c5f6f6b51",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "e02dff55-50fc-4abb-bd2e-2986c66d07c9",
          "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": "e02dff55-50fc-4abb-bd2e-2986c66d07c9",
          "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": "d0fe3f71-9b6e-4d9b-b9cb-94915227ef02",
    "CategoryId": "0486571b-b2f0-4ce4-8143-25e18c2574fe",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "e6b02acb-d48e-48a9-be7b-fbf79f834691",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "e6b02acb-d48e-48a9-be7b-fbf79f834691",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "9f4d7edb-e39e-4684-9f1a-05355092803a",
      "Questions": [
        {
          "Id": "26bc7e04-0349-43e1-ba5c-8b659e8a5793",
          "Answers": "sample string 2"
        },
        {
          "Id": "26bc7e04-0349-43e1-ba5c-8b659e8a5793",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "9f4d7edb-e39e-4684-9f1a-05355092803a",
      "Questions": [
        {
          "Id": "26bc7e04-0349-43e1-ba5c-8b659e8a5793",
          "Answers": "sample string 2"
        },
        {
          "Id": "26bc7e04-0349-43e1-ba5c-8b659e8a5793",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "bf8a9d10-61f6-46bf-8540-8020d3bebc2c",
      "ContentItemId": "a8d819af-1409-4b8f-afa3-09949eeec112",
      "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-11-17T07:40:56.2111393+00:00",
      "RescheduleDate": "2026-11-17T07:40:56.2111393+00:00"
    },
    {
      "Id": "bf8a9d10-61f6-46bf-8540-8020d3bebc2c",
      "ContentItemId": "a8d819af-1409-4b8f-afa3-09949eeec112",
      "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-11-17T07:40:56.2111393+00:00",
      "RescheduleDate": "2026-11-17T07:40:56.2111393+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}