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": "511102a4-b83c-4957-8517-04a6928f20c5",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-11-16T00:35:44.137639+00:00",
  "Registration": [
    {
      "Id": "a2f4c0f4-0a43-4c9c-80b1-85310a1117c3",
      "UserId": "f751c36e-b10c-4660-8da8-0a14050e1249",
      "IsCurrent": true,
      "CenterId": "cd1256b3-7dd2-4194-a009-cb1175a02d65",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "5072717a-626c-4dc4-be72-4dc8126b7e52",
      "EndDate": "2025-11-16T00:35:44.1220119+00:00",
      "StartDate": "2025-11-16T00:35:44.1220119+00:00",
      "SchedulePreferenceDate": "2025-11-16T00:35:44.1220119+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": "a2f4c0f4-0a43-4c9c-80b1-85310a1117c3",
      "UserId": "f751c36e-b10c-4660-8da8-0a14050e1249",
      "IsCurrent": true,
      "CenterId": "cd1256b3-7dd2-4194-a009-cb1175a02d65",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "5072717a-626c-4dc4-be72-4dc8126b7e52",
      "EndDate": "2025-11-16T00:35:44.1220119+00:00",
      "StartDate": "2025-11-16T00:35:44.1220119+00:00",
      "SchedulePreferenceDate": "2025-11-16T00:35:44.1220119+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": "2025-11-16T00:35:44.1220119+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "8271e9dd-8a5a-44fb-baff-a379f62faa93",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "d5832fe8-f926-4f35-932e-1564a1aeedc7",
      "Sequence": 1,
      "AncestorCategoryId": "4345e030-f32c-42d8-8c21-9d310c848b09",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "9ff69875-011d-4d02-a3fc-d5953fd3c3b7",
          "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": "9ff69875-011d-4d02-a3fc-d5953fd3c3b7",
          "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": "8271e9dd-8a5a-44fb-baff-a379f62faa93",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "d5832fe8-f926-4f35-932e-1564a1aeedc7",
      "Sequence": 1,
      "AncestorCategoryId": "4345e030-f32c-42d8-8c21-9d310c848b09",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "9ff69875-011d-4d02-a3fc-d5953fd3c3b7",
          "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": "9ff69875-011d-4d02-a3fc-d5953fd3c3b7",
          "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": "e51fd3a2-331e-4517-bf99-9339e5e4f48a",
    "CategoryId": "0729fc5d-0cc1-48e3-b202-fae76153e65b",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "a49eb57c-9e2b-4eef-9a6a-5104f166aba6",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "a49eb57c-9e2b-4eef-9a6a-5104f166aba6",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "ba622611-f9eb-49d5-9b9c-bc6e0d3d27cb",
      "Questions": [
        {
          "Id": "e2e85402-61c0-4004-b900-601a40c7351d",
          "Answers": "sample string 2"
        },
        {
          "Id": "e2e85402-61c0-4004-b900-601a40c7351d",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "ba622611-f9eb-49d5-9b9c-bc6e0d3d27cb",
      "Questions": [
        {
          "Id": "e2e85402-61c0-4004-b900-601a40c7351d",
          "Answers": "sample string 2"
        },
        {
          "Id": "e2e85402-61c0-4004-b900-601a40c7351d",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "a6642e94-4afd-43a7-a8d5-ad708164515a",
      "ContentItemId": "5ed7f642-4964-4dad-b5eb-48ed416e8333",
      "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": "2025-11-16T00:35:44.1220119+00:00",
      "RescheduleDate": "2025-11-16T00:35:44.1220119+00:00"
    },
    {
      "Id": "a6642e94-4afd-43a7-a8d5-ad708164515a",
      "ContentItemId": "5ed7f642-4964-4dad-b5eb-48ed416e8333",
      "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": "2025-11-16T00:35:44.1220119+00:00",
      "RescheduleDate": "2025-11-16T00:35:44.1220119+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": "511102a4-b83c-4957-8517-04a6928f20c5",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2025-11-16T00:35:44.1688934+00:00",
  "Registration": [
    {
      "Id": "a2f4c0f4-0a43-4c9c-80b1-85310a1117c3",
      "UserId": "f751c36e-b10c-4660-8da8-0a14050e1249",
      "IsCurrent": true,
      "CenterId": "cd1256b3-7dd2-4194-a009-cb1175a02d65",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "5072717a-626c-4dc4-be72-4dc8126b7e52",
      "EndDate": "2025-11-16T00:35:44.1220119+00:00",
      "StartDate": "2025-11-16T00:35:44.1220119+00:00",
      "SchedulePreferenceDate": "2025-11-16T00:35:44.1220119+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": "a2f4c0f4-0a43-4c9c-80b1-85310a1117c3",
      "UserId": "f751c36e-b10c-4660-8da8-0a14050e1249",
      "IsCurrent": true,
      "CenterId": "cd1256b3-7dd2-4194-a009-cb1175a02d65",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "5072717a-626c-4dc4-be72-4dc8126b7e52",
      "EndDate": "2025-11-16T00:35:44.1220119+00:00",
      "StartDate": "2025-11-16T00:35:44.1220119+00:00",
      "SchedulePreferenceDate": "2025-11-16T00:35:44.1220119+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": "2025-11-16T00:35:44.1220119+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "8271e9dd-8a5a-44fb-baff-a379f62faa93",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "d5832fe8-f926-4f35-932e-1564a1aeedc7",
      "Sequence": 1,
      "AncestorCategoryId": "4345e030-f32c-42d8-8c21-9d310c848b09",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "9ff69875-011d-4d02-a3fc-d5953fd3c3b7",
          "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": "9ff69875-011d-4d02-a3fc-d5953fd3c3b7",
          "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": "8271e9dd-8a5a-44fb-baff-a379f62faa93",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "d5832fe8-f926-4f35-932e-1564a1aeedc7",
      "Sequence": 1,
      "AncestorCategoryId": "4345e030-f32c-42d8-8c21-9d310c848b09",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "9ff69875-011d-4d02-a3fc-d5953fd3c3b7",
          "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": "9ff69875-011d-4d02-a3fc-d5953fd3c3b7",
          "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": "e51fd3a2-331e-4517-bf99-9339e5e4f48a",
    "CategoryId": "0729fc5d-0cc1-48e3-b202-fae76153e65b",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "a49eb57c-9e2b-4eef-9a6a-5104f166aba6",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "a49eb57c-9e2b-4eef-9a6a-5104f166aba6",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "ba622611-f9eb-49d5-9b9c-bc6e0d3d27cb",
      "Questions": [
        {
          "Id": "e2e85402-61c0-4004-b900-601a40c7351d",
          "Answers": "sample string 2"
        },
        {
          "Id": "e2e85402-61c0-4004-b900-601a40c7351d",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "ba622611-f9eb-49d5-9b9c-bc6e0d3d27cb",
      "Questions": [
        {
          "Id": "e2e85402-61c0-4004-b900-601a40c7351d",
          "Answers": "sample string 2"
        },
        {
          "Id": "e2e85402-61c0-4004-b900-601a40c7351d",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "a6642e94-4afd-43a7-a8d5-ad708164515a",
      "ContentItemId": "5ed7f642-4964-4dad-b5eb-48ed416e8333",
      "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": "2025-11-16T00:35:44.1220119+00:00",
      "RescheduleDate": "2025-11-16T00:35:44.1220119+00:00"
    },
    {
      "Id": "a6642e94-4afd-43a7-a8d5-ad708164515a",
      "ContentItemId": "5ed7f642-4964-4dad-b5eb-48ed416e8333",
      "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": "2025-11-16T00:35:44.1220119+00:00",
      "RescheduleDate": "2025-11-16T00:35:44.1220119+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}