GET v2/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.View.UserStateViewModel
NameDescriptionTypeAdditional information
UserId

globally unique identifier

None.
IsNewUser

boolean

None.
UserName

string

None.
PrivacyPolicyApprove

boolean

None.
ServerTime

date

None.
Registration

Collection of 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.
StudentSpeakPlusLevelInfo

string

None.

Response Formats

application/json

Sample: 
{
  "UserId": "2d3079be-d101-49d8-9e76-fae413c540aa",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-09-28T02:42:10.0676456+00:00",
  "Registration": [
    {
      "Id": "77f8f2b1-dfd3-40b6-896a-5b742f3596d0",
      "UserId": "93d5a952-33f9-4dc4-9e9c-f7c5701a2e90",
      "IsCurrent": true,
      "CenterId": "013baa89-adea-4dfc-b2c0-bede0a34df44",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "d0a74265-3969-450a-9c4d-e5b84af21ffb",
      "EndDate": "2026-09-28T02:42:10.0676456+00:00",
      "StartDate": "2026-09-28T02:42:10.0676456+00:00",
      "SchedulePreferenceDate": "2026-09-28T02:42:10.0676456+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"
    },
    {
      "Id": "77f8f2b1-dfd3-40b6-896a-5b742f3596d0",
      "UserId": "93d5a952-33f9-4dc4-9e9c-f7c5701a2e90",
      "IsCurrent": true,
      "CenterId": "013baa89-adea-4dfc-b2c0-bede0a34df44",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "d0a74265-3969-450a-9c4d-e5b84af21ffb",
      "EndDate": "2026-09-28T02:42:10.0676456+00:00",
      "StartDate": "2026-09-28T02:42:10.0676456+00:00",
      "SchedulePreferenceDate": "2026-09-28T02:42:10.0676456+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-28T02:42:10.0676456+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "363f4b41-c9b3-40d5-a6f6-3c59b00e61b2",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "56760379-afeb-4294-80b4-c4dc93f39be4",
      "Sequence": 1,
      "AncestorCategoryId": "4678cd5d-58f0-4728-8b1f-72ebb75b4412",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "2ff46033-f5b8-4c0c-b698-2453337efec4",
          "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": "2ff46033-f5b8-4c0c-b698-2453337efec4",
          "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": "363f4b41-c9b3-40d5-a6f6-3c59b00e61b2",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "56760379-afeb-4294-80b4-c4dc93f39be4",
      "Sequence": 1,
      "AncestorCategoryId": "4678cd5d-58f0-4728-8b1f-72ebb75b4412",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "2ff46033-f5b8-4c0c-b698-2453337efec4",
          "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": "2ff46033-f5b8-4c0c-b698-2453337efec4",
          "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": "e7cf7c60-f38a-4b1d-9883-84c6a0cff7d0",
    "CategoryId": "7c486dac-c26d-49ec-9176-49f0a2639000",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "be36daf5-1a3e-4ced-a4ea-89ae0b2f625d",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "be36daf5-1a3e-4ced-a4ea-89ae0b2f625d",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "e37c5c44-b0cc-4cf5-978d-a27e1b5c4f3a",
      "Questions": [
        {
          "Id": "a606939c-81f0-426e-a907-f5c5caa1332c",
          "Answers": "sample string 2"
        },
        {
          "Id": "a606939c-81f0-426e-a907-f5c5caa1332c",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "e37c5c44-b0cc-4cf5-978d-a27e1b5c4f3a",
      "Questions": [
        {
          "Id": "a606939c-81f0-426e-a907-f5c5caa1332c",
          "Answers": "sample string 2"
        },
        {
          "Id": "a606939c-81f0-426e-a907-f5c5caa1332c",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "fb833db3-3e1b-4485-84d0-9b4ce65bb292",
      "ContentItemId": "e8962676-81b5-41e0-a230-55291071a1d6",
      "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-28T02:42:10.0676456+00:00",
      "RescheduleDate": "2026-09-28T02:42:10.0676456+00:00"
    },
    {
      "Id": "fb833db3-3e1b-4485-84d0-9b4ce65bb292",
      "ContentItemId": "e8962676-81b5-41e0-a230-55291071a1d6",
      "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-28T02:42:10.0676456+00:00",
      "RescheduleDate": "2026-09-28T02:42:10.0676456+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}

text/json

Sample: 
{
  "UserId": "2d3079be-d101-49d8-9e76-fae413c540aa",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-09-28T02:42:10.0988942+00:00",
  "Registration": [
    {
      "Id": "77f8f2b1-dfd3-40b6-896a-5b742f3596d0",
      "UserId": "93d5a952-33f9-4dc4-9e9c-f7c5701a2e90",
      "IsCurrent": true,
      "CenterId": "013baa89-adea-4dfc-b2c0-bede0a34df44",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "d0a74265-3969-450a-9c4d-e5b84af21ffb",
      "EndDate": "2026-09-28T02:42:10.0676456+00:00",
      "StartDate": "2026-09-28T02:42:10.0676456+00:00",
      "SchedulePreferenceDate": "2026-09-28T02:42:10.0676456+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"
    },
    {
      "Id": "77f8f2b1-dfd3-40b6-896a-5b742f3596d0",
      "UserId": "93d5a952-33f9-4dc4-9e9c-f7c5701a2e90",
      "IsCurrent": true,
      "CenterId": "013baa89-adea-4dfc-b2c0-bede0a34df44",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "d0a74265-3969-450a-9c4d-e5b84af21ffb",
      "EndDate": "2026-09-28T02:42:10.0676456+00:00",
      "StartDate": "2026-09-28T02:42:10.0676456+00:00",
      "SchedulePreferenceDate": "2026-09-28T02:42:10.0676456+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-28T02:42:10.0676456+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "363f4b41-c9b3-40d5-a6f6-3c59b00e61b2",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "56760379-afeb-4294-80b4-c4dc93f39be4",
      "Sequence": 1,
      "AncestorCategoryId": "4678cd5d-58f0-4728-8b1f-72ebb75b4412",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "2ff46033-f5b8-4c0c-b698-2453337efec4",
          "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": "2ff46033-f5b8-4c0c-b698-2453337efec4",
          "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": "363f4b41-c9b3-40d5-a6f6-3c59b00e61b2",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "56760379-afeb-4294-80b4-c4dc93f39be4",
      "Sequence": 1,
      "AncestorCategoryId": "4678cd5d-58f0-4728-8b1f-72ebb75b4412",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "2ff46033-f5b8-4c0c-b698-2453337efec4",
          "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": "2ff46033-f5b8-4c0c-b698-2453337efec4",
          "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": "e7cf7c60-f38a-4b1d-9883-84c6a0cff7d0",
    "CategoryId": "7c486dac-c26d-49ec-9176-49f0a2639000",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "be36daf5-1a3e-4ced-a4ea-89ae0b2f625d",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "be36daf5-1a3e-4ced-a4ea-89ae0b2f625d",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "e37c5c44-b0cc-4cf5-978d-a27e1b5c4f3a",
      "Questions": [
        {
          "Id": "a606939c-81f0-426e-a907-f5c5caa1332c",
          "Answers": "sample string 2"
        },
        {
          "Id": "a606939c-81f0-426e-a907-f5c5caa1332c",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "e37c5c44-b0cc-4cf5-978d-a27e1b5c4f3a",
      "Questions": [
        {
          "Id": "a606939c-81f0-426e-a907-f5c5caa1332c",
          "Answers": "sample string 2"
        },
        {
          "Id": "a606939c-81f0-426e-a907-f5c5caa1332c",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "fb833db3-3e1b-4485-84d0-9b4ce65bb292",
      "ContentItemId": "e8962676-81b5-41e0-a230-55291071a1d6",
      "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-28T02:42:10.0676456+00:00",
      "RescheduleDate": "2026-09-28T02:42:10.0676456+00:00"
    },
    {
      "Id": "fb833db3-3e1b-4485-84d0-9b4ce65bb292",
      "ContentItemId": "e8962676-81b5-41e0-a230-55291071a1d6",
      "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-28T02:42:10.0676456+00:00",
      "RescheduleDate": "2026-09-28T02:42:10.0676456+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}