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": "51325ca2-9ae0-4dae-a3ea-9aaa4c1bc0d5",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-09-21T10:19:31.7798312+00:00",
  "Registration": {
    "Id": "d968698c-e157-4db4-bd74-586066c3cf8f",
    "UserId": "d85a68da-9860-4e29-a438-146aa3a7b651",
    "IsCurrent": true,
    "CenterId": "d7907373-a9e2-46fd-b645-58b7b652f25e",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "67941298-97c9-413b-972e-fc2c33f5f078",
    "EndDate": "2026-09-21T10:19:31.7642066+00:00",
    "StartDate": "2026-09-21T10:19:31.7642066+00:00",
    "SchedulePreferenceDate": "2026-09-21T10:19:31.7642066+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-21T10:19:31.7642066+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "6182479a-fee1-4f0a-a983-637be4a39873",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "f1a4942e-d000-4518-90fd-ec6681a10a56",
      "Sequence": 1,
      "AncestorCategoryId": "65c4acda-299b-4466-971f-4567fd1da478",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "a8048ed6-7074-4cf7-abe1-18f476c2cace",
          "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": "a8048ed6-7074-4cf7-abe1-18f476c2cace",
          "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": "6182479a-fee1-4f0a-a983-637be4a39873",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "f1a4942e-d000-4518-90fd-ec6681a10a56",
      "Sequence": 1,
      "AncestorCategoryId": "65c4acda-299b-4466-971f-4567fd1da478",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "a8048ed6-7074-4cf7-abe1-18f476c2cace",
          "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": "a8048ed6-7074-4cf7-abe1-18f476c2cace",
          "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": "68581cbf-1f4d-405c-aa4d-1644f14aabce",
    "CategoryId": "4a7e45d6-400b-49ca-b694-67da71a5f131",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "f9577706-c2cc-4af6-b2b1-f41740a233f0",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "f9577706-c2cc-4af6-b2b1-f41740a233f0",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "da4a386d-79aa-414b-ad2d-8375d28ad867",
      "Questions": [
        {
          "Id": "3caa4e21-ca0a-47d5-b0ca-d3fa087aab88",
          "Answers": "sample string 2"
        },
        {
          "Id": "3caa4e21-ca0a-47d5-b0ca-d3fa087aab88",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "da4a386d-79aa-414b-ad2d-8375d28ad867",
      "Questions": [
        {
          "Id": "3caa4e21-ca0a-47d5-b0ca-d3fa087aab88",
          "Answers": "sample string 2"
        },
        {
          "Id": "3caa4e21-ca0a-47d5-b0ca-d3fa087aab88",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "3fbdbc3d-62ef-4e9c-b6c6-1457f5c284d6",
      "ContentItemId": "a6e0a60c-931f-480a-99e3-1174e9a2454d",
      "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-21T10:19:31.7642066+00:00",
      "RescheduleDate": "2026-09-21T10:19:31.7642066+00:00"
    },
    {
      "Id": "3fbdbc3d-62ef-4e9c-b6c6-1457f5c284d6",
      "ContentItemId": "a6e0a60c-931f-480a-99e3-1174e9a2454d",
      "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-21T10:19:31.7642066+00:00",
      "RescheduleDate": "2026-09-21T10:19:31.7642066+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}

text/json

Sample:
{
  "UserId": "51325ca2-9ae0-4dae-a3ea-9aaa4c1bc0d5",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-09-21T10:19:31.7954552+00:00",
  "Registration": {
    "Id": "d968698c-e157-4db4-bd74-586066c3cf8f",
    "UserId": "d85a68da-9860-4e29-a438-146aa3a7b651",
    "IsCurrent": true,
    "CenterId": "d7907373-a9e2-46fd-b645-58b7b652f25e",
    "CenterZone": 5,
    "ContractId": "sample string 6",
    "CurrentContentItemId": "67941298-97c9-413b-972e-fc2c33f5f078",
    "EndDate": "2026-09-21T10:19:31.7642066+00:00",
    "StartDate": "2026-09-21T10:19:31.7642066+00:00",
    "SchedulePreferenceDate": "2026-09-21T10:19:31.7642066+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-21T10:19:31.7642066+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "6182479a-fee1-4f0a-a983-637be4a39873",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "f1a4942e-d000-4518-90fd-ec6681a10a56",
      "Sequence": 1,
      "AncestorCategoryId": "65c4acda-299b-4466-971f-4567fd1da478",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "a8048ed6-7074-4cf7-abe1-18f476c2cace",
          "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": "a8048ed6-7074-4cf7-abe1-18f476c2cace",
          "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": "6182479a-fee1-4f0a-a983-637be4a39873",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "f1a4942e-d000-4518-90fd-ec6681a10a56",
      "Sequence": 1,
      "AncestorCategoryId": "65c4acda-299b-4466-971f-4567fd1da478",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "a8048ed6-7074-4cf7-abe1-18f476c2cace",
          "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": "a8048ed6-7074-4cf7-abe1-18f476c2cace",
          "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": "68581cbf-1f4d-405c-aa4d-1644f14aabce",
    "CategoryId": "4a7e45d6-400b-49ca-b694-67da71a5f131",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "f9577706-c2cc-4af6-b2b1-f41740a233f0",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "f9577706-c2cc-4af6-b2b1-f41740a233f0",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "da4a386d-79aa-414b-ad2d-8375d28ad867",
      "Questions": [
        {
          "Id": "3caa4e21-ca0a-47d5-b0ca-d3fa087aab88",
          "Answers": "sample string 2"
        },
        {
          "Id": "3caa4e21-ca0a-47d5-b0ca-d3fa087aab88",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "da4a386d-79aa-414b-ad2d-8375d28ad867",
      "Questions": [
        {
          "Id": "3caa4e21-ca0a-47d5-b0ca-d3fa087aab88",
          "Answers": "sample string 2"
        },
        {
          "Id": "3caa4e21-ca0a-47d5-b0ca-d3fa087aab88",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "3fbdbc3d-62ef-4e9c-b6c6-1457f5c284d6",
      "ContentItemId": "a6e0a60c-931f-480a-99e3-1174e9a2454d",
      "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-21T10:19:31.7642066+00:00",
      "RescheduleDate": "2026-09-21T10:19:31.7642066+00:00"
    },
    {
      "Id": "3fbdbc3d-62ef-4e9c-b6c6-1457f5c284d6",
      "ContentItemId": "a6e0a60c-931f-480a-99e3-1174e9a2454d",
      "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-21T10:19:31.7642066+00:00",
      "RescheduleDate": "2026-09-21T10:19:31.7642066+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  }
}