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": "ac1978be-f3ba-4be8-b9a3-52c8fa134fd0",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-10-20T05:38:50.0576288+00:00",
  "Registration": [
    {
      "Id": "8a5fce41-e013-459a-b61c-3151a7ee2eb0",
      "UserId": "da41a7bf-4cea-4f4d-8e83-325baee32414",
      "IsCurrent": true,
      "CenterId": "3915243f-c440-47ef-92d2-1b07a16b018d",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "1685ccab-6c23-4155-bd11-2b9c16c854f8",
      "EndDate": "2026-10-20T05:38:50.0576288+00:00",
      "StartDate": "2026-10-20T05:38:50.0576288+00:00",
      "SchedulePreferenceDate": "2026-10-20T05:38:50.0576288+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": "8a5fce41-e013-459a-b61c-3151a7ee2eb0",
      "UserId": "da41a7bf-4cea-4f4d-8e83-325baee32414",
      "IsCurrent": true,
      "CenterId": "3915243f-c440-47ef-92d2-1b07a16b018d",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "1685ccab-6c23-4155-bd11-2b9c16c854f8",
      "EndDate": "2026-10-20T05:38:50.0576288+00:00",
      "StartDate": "2026-10-20T05:38:50.0576288+00:00",
      "SchedulePreferenceDate": "2026-10-20T05:38:50.0576288+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-10-20T05:38:50.0576288+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "28b7b564-733b-4586-82c7-221f294417be",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "4b87220f-1169-4ba4-9b18-68aae8e4ab6e",
      "Sequence": 1,
      "AncestorCategoryId": "9cdd4a4c-0b1c-4c0e-ac50-fcc3a949c74d",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "cd2444fa-931b-424f-a6d9-cf93ca1352f9",
          "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": "cd2444fa-931b-424f-a6d9-cf93ca1352f9",
          "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": "28b7b564-733b-4586-82c7-221f294417be",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "4b87220f-1169-4ba4-9b18-68aae8e4ab6e",
      "Sequence": 1,
      "AncestorCategoryId": "9cdd4a4c-0b1c-4c0e-ac50-fcc3a949c74d",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "cd2444fa-931b-424f-a6d9-cf93ca1352f9",
          "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": "cd2444fa-931b-424f-a6d9-cf93ca1352f9",
          "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": "71efa705-fb97-40dc-b544-75b1a04ed5ff",
    "CategoryId": "96fbc21f-e6a0-4f43-823f-8d5f955b0f7f",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "e90f4471-41c5-442a-8a34-0796c4607bdb",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "e90f4471-41c5-442a-8a34-0796c4607bdb",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "1580411b-84a1-4024-a0cc-2c29b17d23ab",
      "Questions": [
        {
          "Id": "a1a84c6e-3a32-48d7-a93f-d374b4e48f54",
          "Answers": "sample string 2"
        },
        {
          "Id": "a1a84c6e-3a32-48d7-a93f-d374b4e48f54",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "1580411b-84a1-4024-a0cc-2c29b17d23ab",
      "Questions": [
        {
          "Id": "a1a84c6e-3a32-48d7-a93f-d374b4e48f54",
          "Answers": "sample string 2"
        },
        {
          "Id": "a1a84c6e-3a32-48d7-a93f-d374b4e48f54",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "89d8fa82-bf99-49d5-b112-98abf10cffe0",
      "ContentItemId": "4760bfcc-2c0c-4313-b8e6-ee02b0cee018",
      "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-10-20T05:38:50.0576288+00:00",
      "RescheduleDate": "2026-10-20T05:38:50.0576288+00:00"
    },
    {
      "Id": "89d8fa82-bf99-49d5-b112-98abf10cffe0",
      "ContentItemId": "4760bfcc-2c0c-4313-b8e6-ee02b0cee018",
      "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-10-20T05:38:50.0576288+00:00",
      "RescheduleDate": "2026-10-20T05:38:50.0576288+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": "ac1978be-f3ba-4be8-b9a3-52c8fa134fd0",
  "IsNewUser": true,
  "UserName": "sample string 3",
  "PrivacyPolicyApprove": true,
  "ServerTime": "2026-10-20T05:38:50.0888847+00:00",
  "Registration": [
    {
      "Id": "8a5fce41-e013-459a-b61c-3151a7ee2eb0",
      "UserId": "da41a7bf-4cea-4f4d-8e83-325baee32414",
      "IsCurrent": true,
      "CenterId": "3915243f-c440-47ef-92d2-1b07a16b018d",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "1685ccab-6c23-4155-bd11-2b9c16c854f8",
      "EndDate": "2026-10-20T05:38:50.0576288+00:00",
      "StartDate": "2026-10-20T05:38:50.0576288+00:00",
      "SchedulePreferenceDate": "2026-10-20T05:38:50.0576288+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": "8a5fce41-e013-459a-b61c-3151a7ee2eb0",
      "UserId": "da41a7bf-4cea-4f4d-8e83-325baee32414",
      "IsCurrent": true,
      "CenterId": "3915243f-c440-47ef-92d2-1b07a16b018d",
      "CenterZone": 5,
      "ContractId": "sample string 6",
      "CurrentContentItemId": "1685ccab-6c23-4155-bd11-2b9c16c854f8",
      "EndDate": "2026-10-20T05:38:50.0576288+00:00",
      "StartDate": "2026-10-20T05:38:50.0576288+00:00",
      "SchedulePreferenceDate": "2026-10-20T05:38:50.0576288+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-10-20T05:38:50.0576288+00:00"
  },
  "Bookmarks": {
    "sample string 1": {
      "Id": "28b7b564-733b-4586-82c7-221f294417be",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "4b87220f-1169-4ba4-9b18-68aae8e4ab6e",
      "Sequence": 1,
      "AncestorCategoryId": "9cdd4a4c-0b1c-4c0e-ac50-fcc3a949c74d",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "cd2444fa-931b-424f-a6d9-cf93ca1352f9",
          "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": "cd2444fa-931b-424f-a6d9-cf93ca1352f9",
          "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": "28b7b564-733b-4586-82c7-221f294417be",
      "Description": "sample string 2",
      "Duration": 1,
      "IsSkippable": true,
      "Url": "sample string 3",
      "CourseId": "4b87220f-1169-4ba4-9b18-68aae8e4ab6e",
      "Sequence": 1,
      "AncestorCategoryId": "9cdd4a4c-0b1c-4c0e-ac50-fcc3a949c74d",
      "TypeId": 5,
      "TypeName": "sample string 6",
      "Hierarchy": [
        {
          "Id": "cd2444fa-931b-424f-a6d9-cf93ca1352f9",
          "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": "cd2444fa-931b-424f-a6d9-cf93ca1352f9",
          "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": "71efa705-fb97-40dc-b544-75b1a04ed5ff",
    "CategoryId": "96fbc21f-e6a0-4f43-823f-8d5f955b0f7f",
    "DisclaimerConfirmed": true
  },
  "Lessons": [
    {
      "Id": "e90f4471-41c5-442a-8a34-0796c4607bdb",
      "Score": 1.0,
      "State": 1
    },
    {
      "Id": "e90f4471-41c5-442a-8a34-0796c4607bdb",
      "Score": 1.0,
      "State": 1
    }
  ],
  "Surveys": [
    {
      "Id": "1580411b-84a1-4024-a0cc-2c29b17d23ab",
      "Questions": [
        {
          "Id": "a1a84c6e-3a32-48d7-a93f-d374b4e48f54",
          "Answers": "sample string 2"
        },
        {
          "Id": "a1a84c6e-3a32-48d7-a93f-d374b4e48f54",
          "Answers": "sample string 2"
        }
      ]
    },
    {
      "Id": "1580411b-84a1-4024-a0cc-2c29b17d23ab",
      "Questions": [
        {
          "Id": "a1a84c6e-3a32-48d7-a93f-d374b4e48f54",
          "Answers": "sample string 2"
        },
        {
          "Id": "a1a84c6e-3a32-48d7-a93f-d374b4e48f54",
          "Answers": "sample string 2"
        }
      ]
    }
  ],
  "Sessions": [
    {
      "Id": "89d8fa82-bf99-49d5-b112-98abf10cffe0",
      "ContentItemId": "4760bfcc-2c0c-4313-b8e6-ee02b0cee018",
      "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-10-20T05:38:50.0576288+00:00",
      "RescheduleDate": "2026-10-20T05:38:50.0576288+00:00"
    },
    {
      "Id": "89d8fa82-bf99-49d5-b112-98abf10cffe0",
      "ContentItemId": "4760bfcc-2c0c-4313-b8e6-ee02b0cee018",
      "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-10-20T05:38:50.0576288+00:00",
      "RescheduleDate": "2026-10-20T05:38:50.0576288+00:00"
    }
  ],
  "TotalRescheduleCount": 4,
  "StudentLevelInfo": {
    "StartLevel": "sample string 1",
    "EndLevel": "sample string 2",
    "CurrentLevel": "sample string 3"
  },
  "StudentSpeakPlusLevelInfo": "sample string 5"
}