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": "400a0bea-18b4-4b78-b1ad-0040035ac6f5",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-09-24T14:28:43.5806913+00:00",
  "Registration": {
    "Id": "a55cc3f2-ca62-4aac-b316-0065bab5e4a8",
    "UserId": "7dfb5595-944e-4e8e-ac90-b52029c74fa0",
    "IsCurrent": true,
    "CenterId": "3c235758-a343-4d28-b8db-6f32e3395ed4",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "16dccb32-8ab6-4a14-8ad9-8370ed64dcee",
    "EndDate": "2026-09-24T14:28:43.5650678+00:00",
    "StartDate": "2026-09-24T14:28:43.5650678+00:00",
    "SchedulePreferenceDate": "2026-09-24T14:28:43.5650678+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-24T14:28:43.5650678+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "8fe52f4f-ce39-4d5c-b749-54279bca9f90",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "334699fd-78d1-4129-8eb7-3ae7e81d4732",
      "Sequence": 1,
      "AncestorCategoryId": "9874fa24-f217-4185-a9aa-38466e39fa39",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "447b8830-a1d9-45cd-9b0d-930be6691604",
          "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": "447b8830-a1d9-45cd-9b0d-930be6691604",
          "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": "8fe52f4f-ce39-4d5c-b749-54279bca9f90",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "334699fd-78d1-4129-8eb7-3ae7e81d4732",
      "Sequence": 1,
      "AncestorCategoryId": "9874fa24-f217-4185-a9aa-38466e39fa39",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "447b8830-a1d9-45cd-9b0d-930be6691604",
          "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": "447b8830-a1d9-45cd-9b0d-930be6691604",
          "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": "56f17094-2c24-49b8-93a0-061e390f4057",
    "CategoryId": "f68c4f66-f536-4613-846a-5cd797768376",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "3954e17a-ddb3-4adc-af78-3d012b52dfe6",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "3954e17a-ddb3-4adc-af78-3d012b52dfe6",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "4a045654-5c75-4ad5-827e-26a6b59e93af",
      "Questions": [
        {
          "Id": "137c71c6-3b4a-48df-9900-1f4cc779b06c",
          "Answers": "sample string 2"
        },
        {
          "Id": "137c71c6-3b4a-48df-9900-1f4cc779b06c",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "4a045654-5c75-4ad5-827e-26a6b59e93af",
      "Questions": [
        {
          "Id": "137c71c6-3b4a-48df-9900-1f4cc779b06c",
          "Answers": "sample string 2"
        },
        {
          "Id": "137c71c6-3b4a-48df-9900-1f4cc779b06c",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "727dc26a-5f7c-43cc-a8a3-f6e9c0d90299",
      "ContentItemId": "fcc8f984-91af-4ebb-9530-db974125a271",
      "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-24T14:28:43.5650678+00:00",
      "RescheduleDate": "2026-09-24T14:28:43.5650678+00:00"
    },
    {
      "Id": "727dc26a-5f7c-43cc-a8a3-f6e9c0d90299",
      "ContentItemId": "fcc8f984-91af-4ebb-9530-db974125a271",
      "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-24T14:28:43.5650678+00:00",
      "RescheduleDate": "2026-09-24T14:28:43.5650678+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}

text/json

Sample:
{
  "UserId": "400a0bea-18b4-4b78-b1ad-0040035ac6f5",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-09-24T14:28:43.6119409+00:00",
  "Registration": {
    "Id": "a55cc3f2-ca62-4aac-b316-0065bab5e4a8",
    "UserId": "7dfb5595-944e-4e8e-ac90-b52029c74fa0",
    "IsCurrent": true,
    "CenterId": "3c235758-a343-4d28-b8db-6f32e3395ed4",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "16dccb32-8ab6-4a14-8ad9-8370ed64dcee",
    "EndDate": "2026-09-24T14:28:43.5650678+00:00",
    "StartDate": "2026-09-24T14:28:43.5650678+00:00",
    "SchedulePreferenceDate": "2026-09-24T14:28:43.5650678+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-24T14:28:43.5650678+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "8fe52f4f-ce39-4d5c-b749-54279bca9f90",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "334699fd-78d1-4129-8eb7-3ae7e81d4732",
      "Sequence": 1,
      "AncestorCategoryId": "9874fa24-f217-4185-a9aa-38466e39fa39",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "447b8830-a1d9-45cd-9b0d-930be6691604",
          "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": "447b8830-a1d9-45cd-9b0d-930be6691604",
          "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": "8fe52f4f-ce39-4d5c-b749-54279bca9f90",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "334699fd-78d1-4129-8eb7-3ae7e81d4732",
      "Sequence": 1,
      "AncestorCategoryId": "9874fa24-f217-4185-a9aa-38466e39fa39",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "447b8830-a1d9-45cd-9b0d-930be6691604",
          "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": "447b8830-a1d9-45cd-9b0d-930be6691604",
          "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": "56f17094-2c24-49b8-93a0-061e390f4057",
    "CategoryId": "f68c4f66-f536-4613-846a-5cd797768376",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "3954e17a-ddb3-4adc-af78-3d012b52dfe6",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "3954e17a-ddb3-4adc-af78-3d012b52dfe6",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "4a045654-5c75-4ad5-827e-26a6b59e93af",
      "Questions": [
        {
          "Id": "137c71c6-3b4a-48df-9900-1f4cc779b06c",
          "Answers": "sample string 2"
        },
        {
          "Id": "137c71c6-3b4a-48df-9900-1f4cc779b06c",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "4a045654-5c75-4ad5-827e-26a6b59e93af",
      "Questions": [
        {
          "Id": "137c71c6-3b4a-48df-9900-1f4cc779b06c",
          "Answers": "sample string 2"
        },
        {
          "Id": "137c71c6-3b4a-48df-9900-1f4cc779b06c",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "727dc26a-5f7c-43cc-a8a3-f6e9c0d90299",
      "ContentItemId": "fcc8f984-91af-4ebb-9530-db974125a271",
      "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-24T14:28:43.5650678+00:00",
      "RescheduleDate": "2026-09-24T14:28:43.5650678+00:00"
    },
    {
      "Id": "727dc26a-5f7c-43cc-a8a3-f6e9c0d90299",
      "ContentItemId": "fcc8f984-91af-4ebb-9530-db974125a271",
      "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-24T14:28:43.5650678+00:00",
      "RescheduleDate": "2026-09-24T14:28:43.5650678+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}